Giter VIP home page Giter VIP logo

forumapp's Introduction

Simple Forum App

A very simple and small forum web app

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You need to have Node installed to run this project,

$ cd ~
$ curl -sL https://deb.nodesource.com/setup_8.x -o nodesource_setup.sh
$ sudo apt-get install nodejs

Check installation

$ node -v
Output
v8.0.0

Installing

First, download the project, then cd into the project, install dependencies and start the application.

$ git glone https://github.com/rcabarreto/forumApp.git forumApp/
$ cd forumApp/
$ npm install
$ npm start

After the app starts, you can access it on your web browser.

http://localhost:3000

Development

For development, you should use some plugin like uglifyjs to minimize the js files. On Dev mode, the default database will be SQLite and the file will be created on the data folder.

Deployment

I created a Dockerfile to containerize this project making it easy to deploy to a production environment. In production the system uses a production grade database, in this case is MySQL. It also uses a NGINX as proxy server. See docker-compose for more details on the infrastructure.

If you want to try the Docker deployment, just add the following to your hosts file.

127.0.0.1    www.forumapp.com app.forumapp.com pma.forumapp.com

Then just cd into the project and run

$ docker-compose up

Built With

Authors

  • Rodrigo Barreto - Initial work

License

This project is licensed under the MIT License - see the LICENSE.md file for details

forumapp's People

Contributors

rcabarreto avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.