Skip to content

Commit

Permalink
Update README.md (#117)
Browse files Browse the repository at this point in the history
* Update README.md

1. Added setup for env.local
2. Added update for the hosts file

* Update README.md by adding links to docs

I have added documentation link (for setting up realdevsquad.com locally) also added visit website link

* Updated README.md by putting Testing under seperate section
  • Loading branch information
sunilk429 authored Sep 18, 2024
1 parent 46ebabb commit 7296e24
Showing 1 changed file with 27 additions and 12 deletions.
39 changes: 27 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,31 @@ Display the skills a user has and the endorsements created for adding new skills
```

### Setup
- Install local dependencies
```
npm i
```
- Run the development server
```
npm run dev
```
- To run tests
```
npm run test
```

1. **Environment Setup**:
- Create a file named `env.local` in the root directory.
- Copy the contents of `env.sample` and paste them into `env.local`.

2. **Setup locally**:
- Setup `dev.realdevsquad.com` for development using the instructions here - [Avoiding CORS during development](https://github.com/Real-Dev-Squad/website-code-docs/tree/main/docs/dev/https-dev-url-cors)

3. **Install Dependencies**:
```sh
npm i
```

4. **Run the Development Server**:
```sh
npm run dev
```
5. **Go to Website**:
https://dev.realdevsquad.com

### Testing

- To run tests run the following command:

```sh
npm run test
```

0 comments on commit 7296e24

Please sign in to comment.