Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laurabeatris/foodfy
MVC application to explore, manage recipes and chefs - built with Express, Nunjucks, and Postgres
https://github.com/laurabeatris/foodfy
css express mvc nunjucks postgres
Last synced: about 17 hours ago
JSON representation
MVC application to explore, manage recipes and chefs - built with Express, Nunjucks, and Postgres
- Host: GitHub
- URL: https://github.com/laurabeatris/foodfy
- Owner: LauraBeatris
- License: mit
- Archived: true
- Created: 2020-03-08T14:08:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-23T02:50:31.000Z (over 2 years ago)
- Last Synced: 2024-09-26T07:43:24.985Z (about 17 hours ago)
- Topics: css, express, mvc, nunjucks, postgres
- Language: JavaScript
- Homepage:
- Size: 7.13 MB
- Stars: 120
- Watchers: 3
- Forks: 33
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Foodfy
[](https://github.com/LauraBeatris)
[](#)
[](https://github.com/LauraBeatris/foodfy/stargazers)
[](https://github.com/LauraBeatris/foodfy/network/members)
[](https://github.com/LauraBeatris/foodfy/graphs/contributors)
> Take your culinary skills to the next level. Cook, Explore & Manage Recipes.
---
# :pushpin: Table of Contents
* [Features](#rocket-features)
* [Installation](#construction_worker-installation)
* [Getting Started](#runner-getting-started)
* [FAQ](#postbox-faq)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)
# :rocket: Features
* 👩🏽🍳 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.
* 🌏 Multi language support - English and Portuguese.
* 🎨 A cool dark mode theme toggle.
**Obs: The admin platform isn't all translated yet.**
# :construction_worker: Installation
**You need to install [Node.js](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/) first, then in order to clone the project via HTTPS, run this command:**
```git clone https://github.com/LauraBeatris/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 [email protected]:LauraBeatris/foodfy.git```
**Install dependencies**
```yarn install```
Create your environment variables based on the examples of ```.env.example```
```cp .env.example .env```
After copying the examples, make sure to fill the variables with new values.
# :runner: Getting Started
**Running with docker-compose**
In order to prepare the database and also run the application, set your environment variables and then execute docker-compose
```docker-compose up```
With this command, the port seted in your environment `PORT` variable will be available to access the application.
**Manually setup**
You may prefer to manually configure the database and the application.
Install [Postgres](https://www.postgresql.org/) to create a database or if you have [Docker](https://www.docker.com/) in your machine, fill the environment values related to database configurations and the run the following commands in order to create a postgres container.
```docker-compose up postgres```
Execute the follow command to create tables, relationships and procedures:
```yarn db:create```
To start, run the seeds provided in [Seeds](https://github.com/LauraBeatris/foodfy/blob/master/src/database/seeds.js) in order to populate the database with an initial data.
```yarn run:seeds```
Run the following command in order to start the application in a development environment:
```yarn dev```
# :postbox: Faq
**Question:** What are the technologies used in this project?
**Answer:** The tecnologies used in this project are [NodeJS](https://nodejs.org/en/) + [Express Framework](http://expressjs.com/en/) to handle the server, [Nunjucks](https://mozilla.github.io/nunjucks/templating.html) to develop amazing views & [SCSS](https://sass-lang.com/documentation/syntax) to handle the styles architecture and a better maintenance than normal CSS.
##
**Question:** How the multi language support is handled by the server?
**Answer:** This application handle multi language support with the help of a library called [i18n-node](https://github.com/mashpie/i18n-node). It has a middleware that gather language settings of visitors and then persist translations from [JSON files](https://github.com/LauraBeatris/foodfy/tree/master/src/locales) related with a specific locale.
The locale is storaged as a cookie named ```foodfy:locale``` and that can be changed by passing a query string with the value ```?lang=pt```
##
**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.
# :bug: Issues
Feel free to **file a new issue** with a respective title and description on the the [Foodfy](https://github.com/LauraBeatris/foodfy/issues) repository. If you already found a solution to your problem, **i would love to review your pull request**! Have a look at our [contribution guidelines](https://github.com/LauraBeatris/foodfy/blob/master/CONTRIBUTING.md) to find out about the coding standards.
# :tada: Contributing
Check out the [contributing](https://github.com/LauraBeatris/foodfy/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.
# :closed_book: License
Released in 2020.
This project is under the [MIT license](https://github.com/LauraBeatris/foodfy/blob/master/LICENSE).
Made with love by [Laura Beatris](https://github.com/LauraBeatris) 💜🚀