Skip to content
Romulus10 edited this page Aug 30, 2018 · 10 revisions

Projtrack 3

Remember to run ./build.sh test before opening a pull request.

Projtrack 3 Wiki

Before contributing, check out this quick guide to Django.

Windows

Getting Started

For a full guide, refer to the django docs. Download Git, Python, and Pip Once pip is installed, run

> pip install django

Using the git command line installed with git, execute

> git clone https://github.com/cyclerdan/Projtrack3.git

In cmd, execute

> cd Projtrack3\ctleweb
> python manage.py runserver 8080

to start the development server running.

macOS/Linux

Getting Started

Ensure that git, python, and pip are present on your system. If they are, run

$ pip install --user django
$ git clone https://github.com/cyclerdan/Projtrack3.git

to set up the project and

$ cd Projtrack3/ctleweb
$ python manage.py runserver 8080

to run the server.

Quick Git Crash Course

When contributing to the project:

  • Branch with git branch [name] followed by git checkout [name]. This will allow your changes to be made safely in a separate working tree.
  • Make whatever changes you need and periodically save them by running git add *; git commit -am "[message]"; git push origin [name]
  • When you've finished what you're working on, go to Github and file a pull request. The branch will then be tested before being merged with master.

Only working code should ever be committed to master.

Testing with an admin account

Since the binary files and database files are not being shared, the administrative/user accounts will not be shared on the Github repository. In order to access admin functions on the development server, you'll need to run python manage.py createsuperuser to set up the environment.

User Manual

Contribution

System Management

Bug Report/Feature Request

Clone this wiki locally