diff --git a/.gitignore b/.gitignore index 64c339f..0a50d3d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +.DS_Store database/default-content.sql vendor node_modules diff --git a/TODO.md b/TODO.md deleted file mode 100644 index 4d963e0..0000000 --- a/TODO.md +++ /dev/null @@ -1,37 +0,0 @@ -# To Do - -- [ ] Need to create an agent to send data -- [ ] Need to create api endpoint to handle request -- [ ] Need a new table for accounts - - Users can belong to accounts - -## How will authentication work? -JWT or Oauth based tokens - -## Lightweight agent -What data will the agent need to send: - 1. Gather user data - 2. Account id - 3. Site id - -The agent should be availableas a simple script. - -## API Endpoints - -``` -/api/webhook -``` -This will receive a JSON payload from the agent -It will parse the payload to store the data for later display - -``` -/api/dataset/{account_id}/{site_id} -``` -This will provide all metrics to allow displaying -information about the account.:w - -``` -/api/site-list/{account_id} -``` -This will provide a list of sites for a given account. -Each account can have unlimited sites. Each site has an id.