• Project description

• Prerequisites

• Installation

• Running the application
• Running the tests

• Built with

• Contributing

• Authors

• License

• Acknowledgments



ToDoMe is a web-based task manager that lets you organize your tasks for the day and week in an easy manner.
 You earn credits for creating and completing tasks you set for yourself and for passing the quizzes created by your teacher.
 ToDoMe helps the students repeat the curriculum throughout the semester and it gives the professors a better overview of their students' progress.

• Python 2.7+


• Clone the repo by typing the following command in terminal: git clone https://github.com/geromath/ToDoMe.git
• Ensure you have setuptools installed, by typing the following command in terminal: pip install setuptools
• Navigate to the ToDoMe directory and type the following command in terminal: pip install -r requirements.txt
• Navigate into the root directory (/ToDoMe/root) and type the following command in terminal:
• python manage.py migrate alternatively python3 manage.py migrate
• python manage.py makemigrations todolist quizzes
• python manage.py migrate

• You are now ready to start using ToDoMe
• In terminal, type the following command: python manage.py runserver
• The server is now running, and you can navigate to ToDoMe using your preferred browser, and entering "http://localhost:8000/" into the search bar

NOTE: For simplicity's sake, we have added a pre-defined admin user and 2 quizzes for users to take.

• To go to Admin page, allocate to /admin/ (http://localhost:8000/admin/) and input the following information:
• Username: Pekka
• Password: Pekka123 This is mainly to explore admin rights.

• Navigate to the folder where the manage.py file is (ToDoMe/root)
• In the terminal, type: coverage run manage.py test (The displayed test coverage here is highly inaccurate, but needs to be run to create a .coverage file)
• In the terminal, type: python manage.py test (This is the accurately displayed test coverage, as 'coverage run' incorrectly runs our tests, discards tests, etc. It )

NOTE: Currently, test coverage is at approximately 66 %, yet Coveralls did not run our tests, and thus only displayed 21 %. During Sprint delivery 4, we were at a steady ≈ 72 % coverage, however after Coveralls/Travis CI issues occured, many tests fail to run. We are yet to find a solution to this problem, and have temporarily discarded Coveralls. Hence, we display test coverage using terminal.

• Django
• Python
• Bootstrap
• Javascript
• JQuery
• SQLite
• HTML
• CSS

• Make sure you have a GitHub account
• Fork the repository on GitHub
• Create a new branch: git checkout -b newbranchname
• Commit changes: git commit -m "Your text"
• Push to branch: git push origin newbranchname
• Submit pull request

Making changes:

Create a topic branch from where you want to base your work. This is usually the master branch. Please avoid working directly on the master branch.

To create a new branch, type 'git checkout -b newbranchname'

Make commits of logical units. Check for unnecessary whitespace with "git diff --check" before committing. Make sure your commit messages are in the proper format.

• Make sure you have added the necessary tests for your changes.
• Run all the tests to assure nothing else was accidentally broken.

• Mathias
• Erik
• Caroline
• Marius

This project is licensed under the MIT License - see the LICENSE.md file for details

.

The team is grateful for much help from Kari E. Strandjord, our student supervisor, and Pekka Abrahamsson for making it possible to learn software development in practice.

Also, we want to express gratitude towards Magnus L. Hetland for participating in our video.

This has been a long, but joyful journey, and we have learned incredibly much.

Thank you!