Skip to content

Update readme #90 #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sinproject-iwasaki merged 1 commit into from
Dec 11, 2022
Merged

Update readme #90 #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,18 @@ This is a listening and speaking language learning app.

## Prerequisites

- Nothing
- [MySQL Community Server 8.0.30](https://dev.mysql.com/downloads/mysql/) or higher
- [Node.js](https://nodejs.org/) 18.4.0 or higher
- npm 8.13.2 or higher

## Prerequisites for Text-to-Speech

- Set up [Google Cloud Text-to-Speech](https://cloud.google.com/text-to-speech)

## Prerequisites for Translation

- Set up [DeepL API](https://www.deepl.com/pro-api?cta=header-pro-api/)


## Setting up the project

Expand All @@ -27,13 +38,25 @@ cd /talk
npm install
```

## Run locally
2. Create a database named twitter-app
3. Create a .env file by copying .env.example at the top level of the project
4. rewrite the env file.
5. Push the initial schema to the database:

```bash
npx prisma db push
```

6. Run locally

```bash
# Start the server and open the app in a new browser tab
npm run dev -- --open
```

7. Insert initial data only for the first time
- visit http://localhost:5173/init_db

## Feedback

👉 [**Ask a question**](https://github.com/sinProject-Inc/talk/discussions/new)
Expand Down