-
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
1 parent
3eb74c2
commit ed55384
Showing
1 changed file
with
29 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,29 @@ | ||
# RooMates | ||
Roommates is room sharing and management | ||
|
||
## Requirements | ||
- [email protected] | ||
- prisma | ||
|
||
## Installation | ||
|
||
### From source | ||
1. Clone and install dependencies | ||
```bash | ||
git clone [email protected]:sandeshkhadka/RooMates-backend.git | ||
cd RooMates-backend | ||
npm install | ||
``` | ||
2. Setup environment variables | ||
```bash | ||
cp .env.example .env | ||
vim .env | ||
``` | ||
3. Start server | ||
```bash | ||
npm run dev | ||
``` | ||
|
||
### Using Docker | ||
|
||
***Make sure you have your database running before staring the server*** |