Your helpful assistant in writing a complaint letter.

Providing with keyword search, find relevant legal provisions and the most cited judgments and take notes. Best website for those who want to write a simple complaint letter but don't know where to start.

Website: https://rae-lee.github.io/Legal-Dictionary-Frontend

Default account:

Name	Password
user1	12345678
user2	12345678

Front-end Repo: Legal-Dictionary-Frontend Click the link and you can read usage guide there.

Law data came from 全國法規資料庫 APIs.

Judgements data was obtained from scraping 司法院裁判書系統 website by legal-dictinary-crawler.

📖 Feature

|

💾 Development

• It's simple to run Legal-Dictionary on your local computer.
• The following is step-by-step instruction.

1. Get Started

$ git clone https://github.com/Rae-Lee/Legal-Dictionary.git
$ cd Legal-Dictionary
$ npm install

2. Connect to MySQL

Download mysql2

$ npm install mysql2

Or use Docker without downloading.

$ docker pull mysql:latest 
$ docker run -name [your image name] -p 3306:3306 -e MYSQL_ROOT_PASSWORD=[your password] -d

Create a database in your MySQL .

$ winpty docker exec -it [your image name] bash
$ mysql -u root -p
$ CREAT DATABASE [your database name];
$ use [your database name]

Modify the values of username, password and database in config/config.js to connect. And fill in .env.example

3. Fill in .env.example

Add JWT_SECRET_KEY to .env.example.

4. Run migrations and seeders

$ npx sequelize db:migrate
$ npx sequelize db:seed:all

5. Run the application

npm run dev

Execute successfully if seeing following message

It is running on http://localhost:3000

6. Test the application

npm run test

ERD

API DOC

https://lean-scooter-300.notion.site/Legal-Dictionary-API-DOC-42633b09398b4cb08407e16763ef0cef?pvs=4

License

MIT © rae-lee