more-recipe is basically about Food recipes. This app provides a platform for users to share the awesome and exciting recipe ideas they have invented or learnt.
- Create account
- Modify account
- Sign-in account
- Follow user
- Add recipes to catalog
- Modify a recipe
- Delete a recipe
- See all recipes on the catalog
- Upvote or downvote a recipe
- Favorite a recipe
- Review a recipe
- Review a recipe by different user
- Set privacy for Recipe
- Tag user on Recipe
- See most popular recipes on the application
- The client side of this application is built with REACT(Front-end Library) and REDUX(state management)
- The server side is built on NODE using EXPRESS(web framework) as the server,
SEQUELIZE as the ORM(object Relation Mapper) for communicating with POSTGRESQL DB
- Written in ES6 and transpiled down to ES5 with BABEL
- API's is RESTful
- ESLINT, which is configured to Airbnb-base rule
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
You can get the app running locally in the following way:
-
Install NodeJs
node
, version 5 or greater on your machine -
Install
postgres
to your local machine -
Clone the repository and cd into it
git clone https://github.com/akolliy/more-recipe-server.git cd More-recipe-server
-
Install dependenices
npm install
-
Create a database in progresql
In the application src directory, check the config.js file in `server/config/config.js` to setup your database
-
Run database migrations
sequelize db: migrate
-
start the application
- npm run start:dev - Application would be up and running on localhost 2000
WIP (WORK IN PROGRESS)