SWE 573 Software Development Practice

Boğaziçi University Fall'22 Software Development Course Project
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

This projects is for the SWE 573 Software Development Practice course of Boğaziçi University on Fall'22 and supervised by Suzan Uskudarlı. It will be updated each week in order to reflect projects process which is divided into 3 Milestones. You can find out more about it on the wiki.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

Prerequisites

• Download Docker from here

Installation

1. Clone the repo

   git clone https://github.com/ceydaduzgec/SWE573.git

2. Open project with your favorite code editor and a new terminal.

   cd sole_project

3. Run Docker infastructure.

   source tools/run_development.sh

4. Rename the "sample.env.txt" to ".env" file under sole_project and put related values.

5. Migrate the database.

python manage.py migrate

6. (Optional) Create a super user for admin panel.

python manage.py createsuperuser

7. Run the server.

python manage.py runserver 0:8000

8. Go to http://127.0.0.1/ or http://127.0.0.1:80/ from your browser.

To run all the tests:

python manage.py test

When you are done:

• docker-compose -f docker-compose.yml -f docker-compose.yml down (Optional)
• docker system prune (Optional, frees storage by removing all unused images, containers etc. on the host, use with care!)

(back to top)

Linting

Each commit must be linted. Pre-commit is currently configured for flake8, isort and black. So, please install the pre-commit linter hook by running the following command from the terminal you use git:

pip install pre-commit
pre-commit install

To manually run all pre-commit hooks on a repository:

pre-commit run --all-files

To update versions of pre-commit hooks to the latest version automatically:

pre-commit autoupdate

WARNING: .flake8 .pre-commit-config.yaml config.toml rules should be compatible with each other.

Roadmap

• Milestone 1
• Milestone 2
• Milestone 3

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "Type: Enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/SWE573)
3. Commit your Changes (git commit -m 'Add some NewFeature')
4. Push to the Branch (git push origin feature/SWE573)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ceyda Düzgeç - [email protected]

Project Link: https://github.com/ceydaduzgec/SWE573

(back to top)

Acknowledgments

• Suzan Uskudarlı

(back to top)