Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Updated contributing doc where env local had different domains #275

Merged
merged 1 commit into from
Oct 31, 2023
Merged

docs: Updated contributing doc where env local had different domains #275

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Contributing to Review App
# Contributing to Review App

Thank you for your interest in contributing to Review App! We welcome contributions from the community to help improve and enhance the project. Please take a moment to read through the following guidelines to get started.

## Table of Contents

- [Getting Started](#getting-started)
- [Contributing Guidelines](#contributing-guidelines)
- [Setting Up the Development Environment](#setting-up-the-development-environment)
Expand All @@ -24,7 +25,6 @@ Before you start contributing to the frontend, make sure you have:
We follow these guidelines for contributing:

1. Fork the frontend repository to your GitHub account.

2. Clone your forked repository to your local machine:

```bash
Expand All @@ -44,9 +44,7 @@ We follow these guidelines for contributing:
```

5. Make your changes and ensure your code follows our coding standards and practices.

6. Test your changes locally to ensure they work as expected.

7. Commit your changes with clear and concise commit messages:

```bash
Expand Down Expand Up @@ -81,9 +79,10 @@ To set up the development environment locally, follow these steps [Quick video g
3. Create a file named `.env.local` in the root directory of the frontend project and add the following environment variables:

```
NEXT_PUBLIC_AWS_API_URL=http://localhost:8000/local
NEXT_PUBLIC_AWS_API_URL=http://localhost:8000/development
NEXT_PUBLIC_APP_DASHBOARD_DOMAIN=app
NEXT_PUBLIC_APP_DOMAIN=localhost:3000
NEXT_PUBLIC_APP_PUBLIC_DOMAIN=localhost:3000
NEXT_PUBLIC_APP_CUSTOM_DOMAIN=localhost:3000
```

You can also find similar environment variables in `.env.example`.
Expand All @@ -101,6 +100,7 @@ To set up the development environment locally, follow these steps [Quick video g
When you're ready to submit your changes, create a pull request (PR) following our guidelines. Be sure to provide a clear description of your changes in the PR, and one of our maintainers will review it.

## Backend Reference Link

You can find the reference link to the backend of the reivew-app here:
`https://github.com/piyushgarg-dev/review-app-api`

Expand Down
Loading