Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aliamerj authored Mar 20, 2024
1 parent 710d0ec commit f3eece2
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@

Follow these steps to get a local copy up and running.

All tasks and plans for this project listed in this [project page on worknify](https://www.worknify.com/dashboard/2)

### Prerequisites

- Node.js
Expand All @@ -44,10 +46,35 @@ Follow these steps to get a local copy up and running.
- AWS CLI

### Installation
1. Install docker

1. **Clone the repository:**
2. **Clone the repository:**

```bash
git clone https://github.com/aliamerj/worknify.git
cd worknify

3. set up .env
```bash
NEXTAUTH_URL= http://localhost:3000
NEXTAUTH_SECRET= ...
# google
GOOGLE_CLIENT_ID= ...
GOOGLE_CLIENT_SECRET= ...
# FACEBOOK
FACEBOOK_CLIENT_ID=...
FACEBOOK_CLIENT_SECRET=...
# gitub need to change
AUTH_GITHUB_ID=...
AUTH_GITHUB_SECRET=...
# DATABASE
DATABASE_URL=...
PGPASSWORD=...
S3_NAME=...
S3_REGIN=...
IAM_KEY=...
IAM_SECRET=...
```
5. run the app locally with :
```bash
docker compose up
```

0 comments on commit f3eece2

Please sign in to comment.