The social network web app for lovers of new tastes... We know you love to try new things, especially new tastes.
This platform allows users to share thier food recipe discoveries with other users. Users can create new recipes (along with tantalizing images of course) and it will be available to other users to try out, vote, favorite and review.
Project is still being developed both on client and server side. Few endpoints are however available for an overview of the app.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
nodejs (version 8^)
npm
git
postgresql (Version 9.6.5)
# clone the repo
git clone https://github.com/idrisadetunmbi/More-Recipes.git
# install dependencies
npm install
# Ensure to run migrations for the db with the command below
cd server
../node_modules/.bin/sequelize db:migrate
# for development
npm run devstart
# command below builds the app (with babel) into a deployable base and starts the server
npm run start
A demo of the front end is hosted on Github Pages and is available at More-Recipes
API (still under development) is hosted on Heroku and can be accessed through More-Recipes API
API DOCS (showing available routes) is available at More-Recipes API DOCS
Tests have been configured to run with Mocha.
npm run test
Command below will build the code (using babel) for deployment. The generated production folder can be deployed as necessary
npm run build
- ExpressJS - The web framework used
- Materialize CSS - Templates/FE development
API currently defaults to version 1. You can prepend /v1/ to listed routes,e.g. /api/v1/users/signup
Please read CONTRIBUTING.md for details and process for submitting pull requests.
This project is licensed under the MIT License