Skip to content

Commit d1d3e32

Browse files
authored
Merge pull request #41 from tuanle03/main
Rebase Main
2 parents d2692f9 + bec6c55 commit d1d3e32

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ Welcome to the CodeLearn API repository! This project is built using Ruby on Rai
99
- [Getting Started](#getting-started)
1010
- [Installation](#installation)
1111
- [JWT Authentication](#jwt-authentication)
12-
- [Swagger Documentation](#swagger-documentation)
12+
- [API Documentation](#api-documentation)
13+
- [Interactive Database Queries](#interactive-database-queries)
1314
- [Contributing](#contributing)
1415
- [License](#license)
1516

@@ -44,20 +45,29 @@ Before you begin, ensure you have the following prerequisites installed:
4445
```
4546
3. Set up the database:
4647
```bash
47-
rails db:create db:migrate
48+
rails db:create db:migrate db:seed
4849
```
4950
4. Start project
5051
```bash
5152
rails server
5253
```
54+
5355
## JWT Authentication
54-
This project uses JSON Web Tokens (JWT) for user authentication. Make sure to include the JWT token in the Authorization header of your requests:
56+
This project uses JSON Web Tokens (JWT) for user authentication. Make sure to include the JWT token in the Token header of your requests:
5557
```bash
56-
Authorization: Bearer YOUR_JWT_TOKEN
58+
Token: YOUR_TOKEN
5759
```
5860

59-
## Swagger Documentation
60-
Explore the API endpoints and test them using the Swagger documentation at `http://localhost:2106/api/web/doc`.
61+
## API Documentation
62+
Explore the API endpoints and test them using the Swagger documentation at `http://localhost:2106/docs`.
63+
64+
![image](https://github.com/tuanle03/code_learn_api/assets/66480375/482d6fa6-a7b4-42d7-8090-f7f458f732ee)
65+
66+
## Interactive Database Queries
67+
We use Blazer for running SQL queries on our database. To access the Blazer dashboard, go to `http://localhost:2106/mio`. You can create, save, and run queries interactively. Blazer helps us gain insights into our data and make informed decisions.
68+
69+
![image](https://github.com/tuanle03/code_learn_api/assets/66480375/e41aba68-0703-4f69-9b19-a98cb7a2a763)
70+
6171

6272
## Contributing
6373
We welcome contributions! If you find a bug or have an enhancement in mind, please open an issue or submit a pull request.

0 commit comments

Comments
 (0)