Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.5 KB

README.md

File metadata and controls

46 lines (34 loc) · 1.5 KB

AI-Kan

An Ai-Powered project management tool for solo developers.

What doesn't work

  • Although the magic login is working, "/project" is not a protected route.
  • We are working in parallel on the api call to openai and returning better and better quality data, however this is not hooked up to the main application yet.
  • Edits do not persist between refreshes.

What does work

  • Magic link login (locally)
  • Information rendered to page from example data
  • Tasks and issues editing and checking (done)

Collaborating

In order to collaborate to this project, or code review, follow these steps:

Clone the repo

git clone https://github.com/fac27/AI-Kan

Install all dependencies

npm install

You can run the localserver in order to view the latest development version:

npm run dev

Tests

AI-Kan uses Cypress for testing during development. This is fully set up in the dependencies and tests will be run as part of a pre-push hook on Husky. Tests can also be run with the following script:

npm run cypress:run

Link to wireframe

Our wireframe can be seen here

Guidance on naming conventions

Guidance on the naming conventions applied in this code base can be found here