Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
neerajbelsare authored Aug 8, 2024
1 parent 05e8f6a commit 38233ae
Showing 1 changed file with 99 additions and 0 deletions.
99 changes: 99 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,105 @@ Are you a developer? Dive into our [Contributing Guidelines](CONTRIBUTING.md) to
### **Design Contributions**
Attention, designers! Your creativity has the potential to greatly improve our user experience. Please take the time to delve into our Figma design file (accessible through the Figma channel) and kindly share your valuable insights and designs to enhance Schwarz's aesthetics.

### **Setup Schwarz locally**

1. **Fork the Repository**:
1. Navigate to the [Schwarz GitHub repository](https://github.com/Schwarz-Official/Schwarz).
2. Click the "Fork" button in the top-right corner of the repository's page. This will create a copy of the repository in your GitHub account.

2. **Clone Your Fork**:
1. Open your forked repository on GitHub (it should be at `https://github.com/your-username/Schwarz`).
2. Click the "Code" button and copy the URL of your forked repository.
3. On your local machine, open your terminal or command prompt.
4. Navigate to the directory where you want to clone the repository using the `cd` command.
5. Run the following command, replacing `<your-username>` with your GitHub username:
```bash
git clone https://github.com/your-username/schwarz-repo.git
```

3. **Set Up Remote Upstream**:
1. Change your directory to the cloned repository:
```bash
cd Schwarz
```

2. Add the original Schwarz repository as a remote named "upstream" to stay synced with the latest changes:
```bash
git remote add upstream https://github.com/Schwarz-Official/Schwarz.git
```

7. **Install Dependencies**: Schwarz has both frontend (React) and backend (Django) components. First, install the required packages in both the `frontend` and `backend` folders:
```bash
# Inside the frontend folder
cd frontend
npm install
# Inside the backend folder
cd ../backend
pip install -r requirements.txt
```

### Running the Project

#### Frontend (React App)

To run the React app, navigate to the `frontend` folder and start the development server:

```bash
cd frontend
npm start
```

This will start the React development server. You can view the app in your browser at `http://localhost:3000`.

#### Backend (Django Server)

To run the Django backend, navigate to the `backend` folder and apply migrations, create a superuser, and then run the server:

```bash
cd backend
# Apply migrations
python manage.py migrate
# Create a superuser
python manage.py createsuperuser
# Run the server
python manage.py runserver
```

The Django server will be accessible at `http://localhost:8000`.

### Making Your Changes

1. **Create a New Branch**: Before making changes, create a new branch for your work:
```bash
git checkout -b my-feature
```

2. **Make Changes**: Make your changes, add your features, or fix bugs. Remember to follow the project's coding style.
3. **Commit Your Changes**: Commit your changes with a descriptive message:
```bash
git add .
git commit -m "Description of your changes"
```
4. **Push Your Changes**: Push your changes to your forked repository:
```bash
git push origin my-feature
```
### Submitting Your Changes
1. **Create a Pull Request**: Visit your forked repository on GitHub, switch to the branch you created, and click the "New Pull Request" button.
2. **Describe Your Changes**: Fill in a descriptive title and comment explaining your changes. Reference any related issues.
3. **Review and Merge**: A maintainer will review your changes. Once approved, your changes will be merged into the project.
## Upholding Our Community Values
At Schwarz, we treasure a community where respect, inclusivity, and creativity thrive. Please familiarize yourself with our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the standards of behavior we uphold.
Expand Down

0 comments on commit 38233ae

Please sign in to comment.