-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
17 additions
and
0 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
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 |