https://github.com/ansango/robocooker
Robocooker, a food social network oriented to food robots, built in Nextjs
https://github.com/ansango/robocooker
Last synced: 16 days ago
JSON representation
Robocooker, a food social network oriented to food robots, built in Nextjs
- Host: GitHub
- URL: https://github.com/ansango/robocooker
- Owner: ansango
- Created: 2022-04-15T16:20:54.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-02T21:47:32.000Z (almost 4 years ago)
- Last Synced: 2025-01-02T15:49:05.436Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://robocooker.vercel.app
- Size: 1.36 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Table of Contents
## Introduction
### About
This is the base repository of Robocooker, a food social network oriented to food robots.
It'is based on [Next.js](https://nextjs.org/).
## Getting Started
Download this project or clone:
```bash
git clone https://github.com/ansango/robocooker.git
```
and install the dependencies:
```bash
yarn install # or npm install
```
Then run in your terminal:
```bash
yarn dev # npm run dev
```
## Structure
The project is based in Next.js, so it has a structure similar to the one of Next.js. You have a `pages` folder, where you can create your pages, and inside this one you have an api folder with the API routes.
Lib folder contains the libraries services, and queries used by the project.
> Remember Nextjs is based on React and Express, so Frontend and Backend are ready configured.
Checkout the official [Next.js documentation](https://nextjs.org/docs) for more information.
```bash
├── components
│ ├── common
│ ├── dashboard
│ ├── layout
│ ├── pages
│ └── skeletons
├── lib
│ ├── api
│ ├── mocks
│ ├── models
│ ├── services
│ ├── store
│ └── utils
├── pages
│ ├── api
│ ├── blender
│ ├── category
│ ├── dashboard
│ ├── profile
│ ├── recipe
│ ├── recovery
│ └── verify
├── styles
└── types
```
## Frontend
You can find the frontend in the `pages` folder, redux store in the `store` folder, and components in the `components` folder.
```bash
├── components
│ ├── common
│ ├── dashboard
│ ├── layout
│ ├── pages
│ └── skeletons
├── lib
│ ├── store
├── pages
│ ├── blender
│ ├── category
│ ├── dashboard
│ ├── profile
│ ├── recipe
│ ├── recovery
│ └── verify
└── styles
```
## Backend
Next.js is based on Express.js, so you can find the backend in the `pages/api` folder. Libraries, configurations, and queries are in the `lib` folder.
```bash
├── lib
│ ├── api
│ │ ├── auth
│ │ ├── db
│ │ ├── issues
│ │ ├── mail
│ │ ├── middlewares
│ │ ├── nc
│ │ └── schemas
│ ├── services
└── pages
└── api
```
## Environment variables
We will proceed to configure the environment variables. Inside the project we will find an example file (.envexample) to configure the necessary environment variables to be able to have the project fully configured. We must rename it to .env.local to run in dev mode.
You should see something like this:
```bash
# .env.local
MONGODB_URI= # your mongodb uri
CLOUDINARY_CLOUD_NAME= # your cloudinary cloud name
CLOUDINARY_API_KEY= # your cloudinary api key
CLOUDINARY_API_SECRET= # your cloudinary api secret
WEB_URI= # your web uri
NEXT_PUBLIC_WEB_URI= # your web uri
NODEMAILER_PORT= # your nodemailer port
NODEMAILER_HOST= # your nodemailer host
NODEMAILER_USER= # your nodemailer user
NODEMAILER_PASS= # your nodemailer pass
NOTION_KEY= # your notion key
NOTION_DATABASE_ID= # your notion database id
```
This connects to the database, cloudinary service, Notion API, and nodemailer service.
## Deploy
The easiest way to deploy is to use the [Vercel Platform](https://vercel.com/).
Remember to configure the environment variables as in env.local but into settings at Vercel
[Check the official documentation](https://vercel.com/docs/concepts/projects/environment-variables).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
> [Stars are welcome!](https://github.com/ansango/robocooker) ⭐⭐⭐
## License
Distributed under the MIT License. See [`LICENSE.txt`](https://github.com/ansango/robocooker/blob/main/LICENSE.txt) for more information.
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/ansango/robocooker/blob/main/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/ansango