A lightweight django application for using as a logbook
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
Besides that you are probably required to keep a logbook of activities for your university study. A logbook can help you to identify areas of growth or lack thereof. Often during a project, we run into issues, it is a important to be able to reflect on these issues so that they dont turn themselves into repeat mistakes.
Here's why:
- Excel sucks
- Word is meant for essays, a logbook entry should be short and give insight into a specific set of circumstances
- Dev's who can reflect and learn from their mistakes, make the world a better place.
This logbook might not suit all your needs, so feel free to fork the repo or if you have a fundamental feature you want to see, feel free to open a request.
Use the BLANK_README.md to get started.
wait! thats it? yes... i said lightweight didnt i?
To get a local copy up and running follow these simple example steps.
- Python 3.10.2(x64) can be downloaded here
- pip
- virtual environment
To check if python is installed type the following in the commandline/Powershell/bash
python --versionBelow is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
- Clone the repo
git clone https://github.com/ReubenHawley/LogBook.git
- Create virtual env
python3 -m venv /path/to/new/virtual/environment
- Run the install file
./install.sh
- Follow the instructions from django to create a superuser
To use the application:
- run the django app
python manage.py runserver
- open your browser
http://127.0.0.1:8000/admin/ - Log in using the credentials you passed in the commandline
- Enjoy logging
- Add Gui for viewing logs
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
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 "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Reuben Hawley - @theonlyReuben - reubenhawley@gmail.com
Project Link: https://github.com/ReubenHawley/LogBook
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!