More-Recipes is a full stack web application that provides a platform for users to share their awesome and exciting recipe ideas they have invented or learnt.
The full documentation for all API end point can be found here
Users are grouped into 2 categories:
- Create an account (Sign up)
- View Featured Recipes
- View all Recipes
- View a single Recipe
- Search for a Recipe
- Sign in as a user
- Create Recipe
- Update created Recipes
- Delete Created Recipes
- Upvote a Recipe
- Downvote a Recipe
- Add a recipe as Favourite
- View all created Recipe
- View all favourited Recipe
- Remove upvote on a Recipe
- Remove downvote on a Recipe
- Remove Recipe from favourite
- Add Review for a Recipe
- View Profile
- Update Profile
- View Featured Recipes
- View all Recipes
- View a single Recipe
- Search for a Recipe
This project has some Limitations. The most notable ones are:
- Users cannot view other user's profile
- Users cannot view other user's favourited recipes or created recipes
- Users cannot change their password or reset password if forgotten
- Users cannot deactivate their account
- Clone the repository and
change directoryinto the folder
git clone https://github.com/missating/More-Recipes.git && cd more-recipes
- Install project dependencies
npm install
-
Create a
.envfile and copy comtent of.env.sampleto it and provide the appropraite values -
Look at this file config.json and read this to setup postgres/sequelize to create a Database then run migration
npm run migration
- Then start the server
npm run start:dev
- Navigate to your browser to view the app on
http://localhost:3000
View the application here
The application uses the following for Testing:
-
Backend Test
npm run test:server -
FrontEnd Test
npm run test:client
- What language was used to develop this application ?
This is a fullstack Javascript application with client side in React/Redux
- Who can contribute ?
Anyone
Nkoyo Ating miss__ating
This is licensed for your use, modification and distribution under the MIT LICENSE