Take your culinary skills to the next level. Cook, Explore & Manage Recipes.
- 👩🏽🍳 Explore recipes and find amazing chefs.
- 🍕 Create an account to manage recipes, chefs and users.
- 📨 As an administrator of the platform, you're able to invite other users.
You will need to install Node.js first and Yarn if you prefer, then in order to clone the project via HTTPS, run this command:
git clone https://github.com/Raymw1/foodfy.git
SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:
git clone git@github.com:Raymw1/foodfy.git
Install dependencies
- NPM:
npm install - Yarn:
yarn install
Create your environment variables based on the examples of .env.local
cp .env.local .env
After copying the examples, make sure to fill the variables with new values.
Manually setup
You may prefer to manually configure the database and the application.
Install Postgres to create a database.
Execute the follow command to create tables, relationships and procedures:
npm run configure-db
Running seed
In order to prepare the database and also run the application, use the seed file in the seed folder.
You can generate the data already prepared running the seed.js file:
npm run seed-db
Or generating random data running the randomSeed.js file:
npm run random-seed-db
Be sure to fill the Unsplash access key in .env to use their API
Run the following command in order to start the application in a development environment:
npm run dev or yarn dev
Question: What are the technologies used in this project?
Answer: The tecnologies used in this project are NodeJS + Express Framework to handle the server & Nunjucks to develop amazing views.
Question: Are all kind of users able to create and update chefs or recipes?
Answer: The application has two kind of users: Visitors and Administrators. As a administrator, you're able to create, update and view all the data related to recipes, chefs and also other users. Visitors can also access the admin platform but they don't have access to the views responsable to create and update data.
Feel free to file a new issue with a respective title and description on the the Foodfy repository. If you already found a solution to your problem, i would like to review your pull request!
Released in 2020. This project is under the MIT license.
Made with love by Raymw1 💜🚀