More-Recipes provides a platform for users to share the awesome and exciting recipe ideas they have invented or learnt. Suppose a user comes up with a food recipe, he/she can post it on More-Recipes and get feedback in form of reviews and votes from other users who explore that recipe. Users can also keep a list of their favorite recipes on the application.
To install this application,
- Git clone this repository
https://github.com/SannyTee/More-Recipes.git
- Change your directory
cd More-Recipes
- Install all dependencies
npm install
- Create .env file which will be used to load environment variables see sample in
.env.example
file in the project - Migrate
sequelize db:migrate
- Start the app
npm start
for development - Navigate to
localhost:3000
in your browser
npm test
- run the unit test for backendclient-test
- run the unit test for frontend and display code coverage result
- NodeJS - A Javscript runtime built runtime that uses an event-driven non-blocking I/O model that makes it lightweight and efficient.
- ExpressJS - A minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications. This is used in this application for routing to endpoints.
- Javascript ES6: ES6 is the sixth major release of the javascript language specification. It enables features like constants, arrow functions, template literals, spread opeartor, etc.
- React: Facebook open source, efficient, javascript library for building front-end projects.
- PostgreSQL: PostgreSQL is a powerful, open source object-relational database system (ORDBMS) that offers modern database features such as complex queries, foreign keys, etc.
- Sequelize: Sequelize is a promise-based ORM for Node.js that supports different dialects such PostgreSQL, MySQL, and SQLite.
- Webpack: Webpack is used to bundle modules and does tasks automation.
THE Documentation for the More-Recipes Restful API: More-Recipes API
- Airbnb: Airbnb is a coding style guide that guides developers to write clean codes
- Users cannot deactivate their accounts
- Users can only create account once with their username and email
- Users can not delete their reviews
- Fork this repository.
- Clone it.
- Create your feature branch on your local machine with
git checkout -b your-feature-branch
- Push your changes to your remote branch with
git push origin your-feature-branch
- Open a pull request to the master branch, and describe how your feature works
- Refer to this wiki for proper GIT CONVENTION
- Sanni Taiwo