Robocooker

Create your own cooking recipes for food processors

Report a bug

Table of Contents

1. Introduction
2. Getting Started
3. Structure
4. Frontend
5. Backend
6. Environment variables
7. Deploy
8. Contributing

Introduction

About

This is the base repository of Robocooker, a food social network oriented to food robots.

It'is based on Next.js.

Getting Started

Download this project or clone:

git clone https://github.com/ansango/robocooker.git

and install the dependencies:

yarn install # or npm install

Then run in your terminal:

yarn dev # npm run dev

back to top

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 for more information.

├── components
│   ├── common
│   ├── dashboard
│   ├── layout
│   ├── pages
│   └── skeletons
├── lib
│   ├── api
│   ├── mocks
│   ├── models
│   ├── services
│   ├── store
│   └── utils
├── pages
│   ├── api
│   ├── blender
│   ├── category
│   ├── dashboard
│   ├── profile
│   ├── recipe
│   ├── recovery
│   └── verify
├── styles
└── types

back to top

Frontend

You can find the frontend in the pages folder, redux store in the store folder, and components in the components folder.

├── components
│   ├── common
│   ├── dashboard
│   ├── layout
│   ├── pages
│   └── skeletons
├── lib
│   ├── store
├── pages
│   ├── blender
│   ├── category
│   ├── dashboard
│   ├── profile
│   ├── recipe
│   ├── recovery
│   └── verify
└── styles

back to top

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.

├── lib
│   ├── api
│   │   ├── auth
│   │   ├── db
│   │   ├── issues
│   │   ├── mail
│   │   ├── middlewares
│   │   ├── nc
│   │   └── schemas
│   ├── services
└── pages
  └── api

back to top

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:

# .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.

back to top

Deploy

The easiest way to deploy is to use the Vercel Platform.

Remember to configure the environment variables as in env.local but into settings at Vercel

Check the official documentation.

back to top

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

back to top

Stars are welcome! ⭐⭐⭐

License

Distributed under the MIT License. See LICENSE.txt for more information.