Skip to content

AmineAML/thermopolia-app

Repository files navigation


The Thermopolia App

A daily recipe recommendation and newsletter, check out the API

EthymologyHow to useBuilt withRepository structure License

screenshot

Ethymology

Thermopolia (plural of thermopolium) was the ancient Roman/Greek equivanlt to restaurants. It was a commercial establishment for purshasing ready-to-eat food and often with servings similar to modern fast food. This name is a good description to what the application offers from easy-to-prepare recipes, newsletter subscriptions and delivery and other amazing features.

How to use

Installation

This app is built with Node.js v14+ and NPM v8+, you can use Yarn or any other package manager after doing the required changes.

# Clone the repository
git clone git@github.com:AmineAML/thermopolia-app.git
cd thermopolia-app
npm install

Developing

Before running the app, rename .env.example to .env and add your environment variables.

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

We're using the Netlify adapter, the build could change depending on which adapter you choose to use.

npm run build

You can preview the built app with npm run preview, regardless of whether you installed an adapter. This should not be used to serve your app in production.

Deploying

We're using Netlify with plugins to deploy this project, deploying may differ depending on the adapter that you may choose to use or you can use Docker.

Built with

Repository structure

/
├─ docs/             # Documentation
├─ src/
│  ├─ lib/           # Components, stores, types and variables
│  │
│  ├─ routes/        # Pages
│
├─ static/           # Assets
└─ ..                

License

This project is license under MIT.

About

A daily recipes recommendation and newsletter

Topics

Resources

License

Stars

Watchers

Forks