anaplian / tinylog Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 99 KB

TinyLog - Track what you've done and when

License: MIT License

JavaScript 32.38% HTML 1.23% CSS 2.56% Makefile 1.31% Python 56.79% Shell 0.81% Gherkin 4.11% Batchfile 0.80%

tinylog's Introduction

tinylog

TinyLog - Track what you've done and when

tinylog's People

Contributors

Watchers

tinylog's Issues

Create base server application

Set up a base server application with tests & linting based on Flask & SQLAlchemy

User login/logout (API)

As a user I want to be able to log into/out of the application if I have an active account.

Given the user has a valid account
When a POST request is made to /login containing their username & password
Then the proper cookies (CSRF & session) should be set in their browser

Create Landing Page

Create a landing page that describes the product and provides an entry point to account creation

Create JS client library for API

Create the basic framework of a JavaScript library for interacting with the REST API

User account creation (API)

As a user, I want to be able to create an account so that I can use the app and protect my logs from being modified by other users.

Data model: https://github.com/turingincomplete/tinylog/wiki/Data-Model#users

Given that a user is not logged in
When a user POSTs new user data to the /users URL and the user data is valid
Then a 201 response should be returned and a link to the new user resource should be returned

Given that a user is not logged in
When a user POSTs new user data to the /users URL and the user data is not valid
Then a 4xx response should be returned and no new user object should be created

Given that a user is logged in
When a user POSTs new user data to the /users URL
Then a 4xx response should be returned and no new user object should be created

Create base AngularJS frontend application

Create the basic framework for the AngularJS Frontend Application

Delete Logs & Entries

As a user I want to be able to delete my logs & log entries

Note:
Look into whether we want to truly delete these things or "archive" them like Trello does

Write a better README

Write a better README for the project containing:

Short project description
Link to the live version
Installation instructions
Documentation

Update Log & Entry data

As a user I want to be able to update the titles and descriptions of my Logs and their entries

Build base frontend architecture

Flesh out basic architecture for frontend app

Server Tooling for Windows

Create batch script equivalents of server tools so that it can run on Windows

User login/logout (Frontend)

As a user I want to be able to log in and out of the application

User account creation (Frontend)

As a new user, I want to be able to register a new account so that I can authenticate and use the site.

Given that the user has visited the registration page and they have entered valid data according to https://github.com/turingincomplete/tinylog/wiki/Data-Model#users
When they press submit
Then a POST request should be sent to the /api/users/ resource containing the user data and a success/failure message should be displayed depending on the server response

Create new Log

As a user, I want to be able to create new log timelines in the application so that I can track my log history

Given the user is logged in
When a POST request is sent with a body describing a valid Log (https://github.com/turingincomplete/tinylog/wiki/Data-Model#tinylog)
Then a new log should be created