Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/VincentCordobes/the-green-meal
🍒 Keep track of your meals calories
https://github.com/VincentCordobes/the-green-meal
antd nextjs react sql
Last synced: about 2 months ago
JSON representation
🍒 Keep track of your meals calories
- Host: GitHub
- URL: https://github.com/VincentCordobes/the-green-meal
- Owner: VincentCordobes
- License: mit
- Archived: true
- Created: 2019-07-25T11:04:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-21T23:09:56.000Z (over 2 years ago)
- Last Synced: 2024-08-04T01:05:48.114Z (5 months ago)
- Topics: antd, nextjs, react, sql
- Language: TypeScript
- Homepage: https://the-green-meal.herokuapp.com
- Size: 1.19 MB
- Stars: 83
- Watchers: 5
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ant-design - The Green Meal - Next.js, PostgreSQL demo app written in TypeScript. (Boilerplates / Themes)
README
# 🍒 The Green Meal
> Keep track of your meals calories
Next.js 9, antd, Node, PostgreSQL demo app—written in TypeScript with raw sql.
What's implemented:
- Authentication and ACLs
- CRUD meals and users
## Table of contents
- [Setup](#setup)
- [Requirements](#requirements)
- [Install dependencies](#install)
- [Start](#start)
- [Database](#database)
- [Tests](#tests)
- [Usage](#usage)
- [Login](#login)
- [Signup](#signup)
## Setup
### Requirements
- Node.js (tested on `v10`)
- PostgreSQL >= `11.3`
### Install dependencies
```
npm install
```
### Start
```
npm run build && npm run start
```
### Database
Init a db, create the tables and insert some dummy data.
```
npm run db:setup
```
## Tests
⚠️ Tests make db calls, so an instance of postgres being up is required.
```
npm test
```
## Usage
### Login
You can login, by default with:
- An admin user → login: `[email protected]`, password: `meals`
- A regular user → login: `[email protected]`, password: `meals`
- A manager → login: `[email protected]`, password: `meals`
### Signup
When creating an account—to confirm the provided email addres—a confirmation link is printed to the server stdout. This is to simulate the link normally sent to user mailbox.
Same for password reset.