Skip to content

Commit

Permalink
add setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sandeshkhadka committed Jun 21, 2024
1 parent 3eb74c2 commit ed55384
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
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***

0 comments on commit ed55384

Please sign in to comment.