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.
https://more-recipes-app.herokuapp.com/
The API documentation can be viewed at here
- NodeJS
- Express
- React
- PostgreSQL
- Sequelize
- Babel
- Webpack
- Axios
- Git clone this repository
https://github.com/Ruqoyah/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:8000
in your browser
- Run the server test with
npm run server:test
- Run the client test with
npm run client:test
- Run end to end test with
npm run e2e:test
- Users cannot deactivate their accounts
- Users can only create account once with their username and email
- Users can login and obtain a token which is verified on every request
- Users will have to obtain a fresh token after 24 hours when their session has expired
- Users will only be able to access the full application functionalities only if they are logged in
- Airbnb: Airbnb is a coding style guide that guides developers to write clean codes
- 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
Ensure your codes follow AirBnB Javascript Styles Guide
- Rukayat Odukoya
This project is licensed under the Apache License - see the LICENSE file for details