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 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.
With this app users can do the following:
- Create an account
- Sign in as a user
- View Recipes
- Create New recipe
- Update created recipes
- Delete recipe created
- Add recipes to their favorites list
- Upvote a recipe
- downvote a recipe
- Review a recipe
- Update profile
The following are some of the technologies used on this project.
- NodeJs | is an open-source, cross-platform JavaScript run-time environment for executing JavaScript code on the server-side.
- Express | is a web application framework for Node.js designed for building web applications and APIs.
- React/Redux | is a JavaScript library for building user interfaces.
- Wepack | an application bundling tool.
- Babel | for transpilling ES6 or earlier version of javascript to older versions.
- Sequelize | An ORM framework for postgres database
- MaterializeCss | is a modern responsive CSS framework based on Material Design by Google.
- Airbnb: is a coding style guide that guides developers to write clean codes.
- Clone Repository by running
git clone https://github.com/JaphethCA/More-recipe.git - After that change directory to the repo with
cd More-recipe - Run
npm installto install dependency packages - Start App locally by running
npm start:dev - Then navigate to "http://localhost:50000" to view app in browser
To test app:
- You will have to create a separate test database and configure it as in .env.example file
- Run server side tests with
npm test - Run client side test with
npm run test:client
- Clone this repository.
- branch out to feature/bug/chore
- work on feature/bug/chore
- Raise a pull request to the master branch with brief description of what it does
Notes: Ensure your codes follow AirBnB Javascript Styles Guide
More-recipe (Hosted on Heroku)
More-recipe (API Documentations)
This project is licensed under MIT License, see LICENSE for more info.