Skip to content

A Tutorial on Developing a Website where users can share the projects they have developed with other developers and , interact with them.

License

Notifications You must be signed in to change notification settings

amandewatnitrr/django-tutorial

Repository files navigation

Django Tutorial

  • Welcome to the Django Project repository! This project is an open-source web application built using Django, a high-level Python web framework. We are thrilled to have you here and appreciate your interest in contributing to this project.

Project Overview

  • This Django project is designed to teach you basics of Backend Development with Django. The Project is a Website where Users(Software Developers) can signup, share there skillsets and projects, over there profile, and get reviews from other developers. They can also communicate via messages as well.

Getting Started

  • To set up the project on your local machine, follow these instructions:

Prerequisites

  • Before you begin, make sure you have the following installed:

    • Python [3.11.3]
    • Django [4.1.7]

Installation

  • Clone the repository to your local machine:

    git clone https://github.com/yourusername/django-project.git
  • Navigate to the project directory:

    cd django-tutorial
  • Create a virtual environment (optional but recommended):

    python -m venv venv
  • Activate the virtual environment:

    • On Windows:

      venv\Scripts\activate
    • On Mac and Linux

      source venv/bin/activate
  • Move to the folder, where requirements.txt file is present, and run:

    pip install -r requirements.txt
  • Run database migrations:

    python manage.py makemigrations
    python manage.py migrate
  • Start the development Server:

    python manage.py runserver
  • Access the application in your web browser at http://localhost:8000/

Contribution Guidelines

We welcome contributions from the community. To get started, follow these guidelines:

  1. Fork the Repository Click the "Fork" button on the top-right corner of this repository to create a copy of it in your GitHub account.

  2. Clone Your Fork Clone your forked repository to your local machine. Replace [yourusername] with your GitHub username:

git clone https://github.com/[yourusername]/django-tutorial.git
  1. Create a New Branch Create a new branch for your feature or bug fix. Use a descriptive branch name:
git checkout -b feature/your-feature-name
  1. Make Changes Make the necessary code changes in your branch. Ensure that your changes align with the project's coding standards.

  2. Test Your Changes Before submitting a pull request, test your changes to make sure they work as expected. Run any relevant tests, and ensure that the code is error-free.

  3. Commit and Push Commit your changes and push them to your forked repository:

git commit -m "Add your commit message here"
git push origin feature/your-feature-name
  1. Create a Pull Request Visit the original repository on GitHub and click the "New Pull Request" button. Provide a descriptive title and explain your changes in the pull request description.

  2. Code Review Your pull request will be reviewed by project maintainers. Be prepared to address any feedback or make further changes if necessary.

  3. Merge Once your pull request is approved, it will be merged into the main project. Congratulations, you've successfully contributed to the project!

Code of Conduct

Please read and adhere to our Code of Conduct.

License

This project is licensed under the [License Name] - see the LICENSE file for details.

Thank you for contributing to our project! We appreciate your support and look forward to your contributions.

Happy coding! 🚀

About

A Tutorial on Developing a Website where users can share the projects they have developed with other developers and , interact with them.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published