-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #46 from dribble-njr/feat/home
feat: home page & category api
- Loading branch information
Showing
50 changed files
with
914 additions
and
207 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Imperial Kitchen | ||
|
||
[](https://expo.dev/client) [](https://nestjs.com/) [](https://www.prisma.io/) [](https://www.mysql.com/) [](https://redis.io/) | ||
|
||
[中文版](README.md) | ||
|
||
A food ordering app for family kitchen. | ||
|
||
## Features | ||
|
||
- [x] Auth: JWT Login, register, logout. | ||
- [x] Multi-language support, theme color, theme mode. | ||
- [ ] Browse menus:View all kinds of food and their details, including images, descriptions and prices. | ||
- [ ] Order food:Choose food and add it to shopping cart. | ||
- [ ] Recipe: Generate recipes. | ||
- [ ] Profile: View personal information, order history, virtual coins. | ||
- [ ] AI assistant: Ask questions about the menu. | ||
|
||
## Develop | ||
|
||
To develop Expo, you should read [Tools for development](https://docs.expo.dev/develop/tools/) firstly. | ||
|
||
1. Fork this repository to your GitHub account. | ||
2. Install `yarn@1.22.22` and `node@20.10.0`. | ||
3. Download repo and install deps. | ||
```sh | ||
git clone <your_clone_repo> | ||
cd imperial-kitchen | ||
yarn install | ||
``` | ||
4. Run mobile. | ||
```sh | ||
yarn dev:mobile | ||
``` | ||
5. Install and configure [`mysql`](https://www.mysql.com/), [`nodemailer`](https://nodemailer.com/) and [`redis`](https://redis.io/try-free/). | ||
> [!NOTE] | ||
> If you use [`docker`](https://www.docker.com/) to start the server, you can skip the configuration of `mysql`. | ||
6. Configure server env: rename **server/.env.example** to **server/.env**. | ||
```shell | ||
# PORT=8000 | ||
# DB_URL="mysql://root:root@host.docker.internal:3306/imperial_kitchen" | ||
|
||
# # nodemailer | ||
# nodemailer_host= | ||
# nodemailer_auth_user= | ||
# nodemailer_auth_pass= | ||
|
||
# # jwt | ||
# JWT_SECRET=agshddgfsd | ||
|
||
# # redis | ||
# REDIS_PASSWORD= | ||
# REDIS_URL= | ||
``` | ||
|
||
> [!NOTE] | ||
> If start server with `docker`, you get `Can't reach database server at host.docker.internal:3306` error, please check the host configuration. | ||
7. Run server, and the api docs can be viewed at [api-docs](http://localhost:8000/api-docs). | ||
```sh | ||
yarn dev:server | ||
``` | ||
or use docker to start the server: | ||
```sh | ||
yarn docker:dev | ||
``` |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.