Skip to content

Commit

Permalink
chore: cheching the workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
shawakash committed Jul 27, 2024
1 parent 1ee5bad commit c126d28
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions crates/api/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# xChange_api

## Description
Rust based API for the xChange project. The API is built using the Actix_web framework and Diesel ORM.

## Setup
1. Install Rust
2. Install Diesel CLI
3. Install Postgres
4. Create a database in Postgres
5. Run `diesel setup` to setup the database
6. Run `diesel migration run` to run the migrations
7. Run `cargo run` to start the server

## Endpoints
1. POST /user/register - Create a new user
2. POST /users/login - Login a user

0 comments on commit c126d28

Please sign in to comment.