Focus is a personal project to help me get things done.
Currently it is a simple, opinionated todo list. Soon Focus will be a fully featured, modular, type based productivity multitool.
Focus's backend is a simple django application with a
django-rest-framework API. It is configured to run on mysql (you may
need to change the db settings in focus/settings.py). The frontend is an
Aurelia application. Aurelia is a JavaScript client
framework build on next gen JS (ES6-7).
To get up and running simply clone this repository, and setup the DB using:
./manage.py syncdb
./manage.py migrate
The development tools are managed through npm.
Install the npm packages with npm install
Frontend dependencies are managed with jspm.
Install the bower packages with jspm install -y
The static assests are built using gulp.
Build and watch the assests with gulp watch
You need to have both the API server and the frontend server running to view
Focus. gulp watch should handle serving the frontend. You will need to
run ./manage.py runserver to start the django server.
Browse to http://localhost:9000 to see the app.
Django development is split into applications. Currently the base
application is focus. This holds the settings etc. Models and API views are
in the todos application.
JavaScript development is in ES6-7. You can learn about it
here. The frontend files are found in the
src directory. The browser should auto-refresh as you save files (you may
need the live-reload browser plugin).
CSS development is using SCSS. Style files should be modularised where necessary/sensible. I'm not following any particular style guide at the moment. I might migrate the code to something while the codebase is small.
Concise modules are imported in
frontend/scss/_framework.scss as needed.
Focus is currently a morning routine builder. It helps you complete your morning tasks without the worry of forgetting something.
Tasks have no time restraints and are to be completed everyday no matter what time you wake.
Examples of Focus todos:
- Meditate
- Complete journal
- Clean teeth
- Strech
- ...
This list should contain tasks which need to be completed everyday.
When you wake you should reset the todos and click on the first task. This will take you to focus mode. Focus mode is a distraction free screen which only shows you the text of the current task. Go now and complete this task. Focus on completing this todo. When it is complete, click on the tick and move on to the next one.
You can add todos to the bottom of the list using the form at the bottom of the page. You can reorder todos by grabbing the todo number and dragging. You can edit the text of a todo by clicking on the pencil icon for that todo. You can delete a todo by clicking on the bin icon. There is also a quick complete button for finishing a task while in list mode
Django tests are run using ./manage.py test
Aurelia test are yet to be written.
- Fork it!
- Create your feature branch:
git checkout -b feature/my-new-feature - Commit your changes:
git commit -am 'Added some feature' - Push to the branch:
git push origin feature/my-new-feature - Submit a pull request :D
- Version 0.1: Basic sequential todo list. Tests and readme written.
- Version 0.2: Conversion of frontend to use the Aurelia framework.
- Version 0.3: Added CRUD.
Focus was created by Alex Price (@ricemast)
The MIT License (MIT)
Copyright (c) 2015 Focus
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.