A Yik Yak style web app built with React.js (Frontend), and Node.js (Backend).

After downloading or cloning this repository, you should go to the src folder, where the code is located. Then, run:

$ npm install

That will install the dependencies for this project. Then, you will need to create a database to store the data from the application. Since we are using Sequelize ORM, we can use different DBMS and it should work regardless of which one you choose.

Note: The system is being developed with MySQL, but if you want to use PostgreSQL, for instance, you can do so by updating the package.json with the respective libraries and src/config/config.json to reflect so.

This project uses Webpack to primarily to transpile, optmise and bundle our React code and its dependencies. Before running the project, run:

$ webpack

This will bundle the project code (Components, etc), React and ReactDOM libraries and other dependencies to /public/js/app.js, which will be required in the client-side of our application.

Finally, you can run the server, by running:

$ node server.js

Note that the server won't restart itself if any errors happen using the node command. Using the nodemon package is the ideal for that matter.

ESLint is being used to create a standard for our codebase. If you plan on sending a PR, please check that you code is compliant with this project's .eslintrc.json rules via ESLint. Our ruleset is initally based on AirBNB ECAMScript5 styleguide (Now called airbnb/legacy) with addition of custom rules. Since this is a project meant for the author learning good development practices, there ain't a need for new contributors. If you feel the need/will to do so, please contact the author.

This project is licensed under the terms of the GNU General Public License v3.0 (GPLv3). A copy of this licence can be also found in this repository, in LICENCE.MD .

Header icon made by Freepik from www.flaticon.com is licensed under CC BY3.0