From 05e8f6a798ca7395564b8ff0403db5b741b6b1c1 Mon Sep 17 00:00:00 2001 From: Neeraj Belsare <77576255+neerajbelsare@users.noreply.github.com> Date: Thu, 8 Aug 2024 17:24:49 +0530 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 98 +------------------------------------------------ 1 file changed, 1 insertion(+), 97 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fc3b090..1c4da7a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,103 +44,7 @@ We welcome UI/UX design contributions to enhance the user experience of Schwarz. ## Code Contributions -### Setting Up the Project - -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 `` 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. +For detailed instructions on setting up the codebase and the overall software release workflow of Schwarz, please refer to the [README](./README.md). Thank you for your contribution to Schwarz! If you have any questions or need further assistance, feel free to reach out. Happy coding! 🚀