ASD Management

Responsive web app for managing a Sports Association.

Work in Progress....

Backend deploy (django-vercel / postgres-supabase):

https://asd-management-django.vercel.app/

Frontend deploy (react-netlify):

https://asd-management.netlify.app/

Installation

Follow these steps to set up and run the project locally.

1. Clone the Repository

Clone the repository to your local machine using Git:

git clone https://github.com/aleattene/asd-management-webapp-responsive-backend-django.git

2. Navigate to the Project Directory

cd asd-management-webapp-responsive-backend-django

3. Create a Virtual Environment

It's recommended to use a virtual environment to manage project dependencies.

Using venv:

python3.11 -m venv asd_venv

4. Activate the Virtual Environment

On Unix or macOS:

source asd_venv/bin/activate

On Windows:

asd_venv\Scripts\activate

5. Install Dependencies

Install the required Python packages using pip:

pip install --upgrade pip
pip install -r requirements.txt

---

Configuration

The project uses environment variables to manage sensitive information and configuration settings. Follow these steps to set up your environment variables.

1 Create a .env File

In the root directory of the project, create a file named .env

2. Add Environment Variables

Open the .env`` file in your preferred text editor and add the following variables:

SECRET_KEY=
DEBUG=
ALLOWED_HOSTS=

---

Running the Server

Once the setup is complete, you can run the Django development server.

1. Apply Migrations

Ensure all database migrations are applied:

python manage.py migrate

2. Create a Superuser (Optional)

To access the Django admin interface, create a superuser:

python manage.py createsuperuser

Follow the prompts to set up your superuser account.

3. Run the Development Server

Start the Django development server:

python manage.py runserver

Access the application by navigating to http://localhost:8000/ in your web browser.

---

Running Tests

The project uses Django's built-in testing framework along with coverage.py to measure test coverage.

1. Run Tests with Coverage

Execute the tests and generate a coverage report:

coverage run manage.py test && coverage report --show-missing

---

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the Repository

Click the "Fork" button on the top-right corner of the repository page.

2. Clone Your Fork

git clone https://github.com/aleattene/asd-management-webapp-responsive-backend-django.git

3. Create a New Branch

git checkout -b feature/your-feature-name

4. Make Your Changes

5. Commit Your Changes

git commit -m "Add a meaningful commit message"

6. Push to Your Fork

git push origin feature/your-feature-name

7. Create a Pull Request

Go to the original repository and create a pull request from your fork (from the feature/your-feature-name branch to the main branch).

---

License

This project is licensed under the MIT License.

---