Skip to content

kelsny/athens

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Athens Project

This repository is for the [Cursors] does the entire fucking thing in one week challenge dead

Athens Project Routing

A * means authentication is required.

Routes

/                             Home page
/*                            User's notes
/:id*                         View and manage a note
/settings*                    User's settings
/premium*                     View premium plans

API Routes

/auth                         GET        Authentication
/auth/redirect                GET        Callback URI
/auth/logout                  GET        Log out
/api/notes/:email             GET        User's notes
/api/edit*                    POST       Edit a note
/api/delete*                  POST       Delete a note
/api/new*                     POST       Create a new note
/api/explore?q=:query         GET        Search other notes and outlines
/api/user/delete*             POST       Delete user's account
/api/user/username*           POST       Update user's username
/api/user/premium/:plan*      POST       Update user's premium plans
/api/user/premium/remove*     POST       Remove user's premium plans

Athens Project Database User Schema

_id              User's email
username         User's username
avatar           User's avatar
notes            User's notes
  name
  note
  website
  private
  id
premium          User's premium plans
isSubscribed     Is the user subscribed (so we can get that moolah every month)

Athens Project Packages

Excluding type definitions

next                  Next.js
react                 React.js
react-dom             React.js DOM
express               Custom server
passport              Authentication
passport-github       GitHub Authentication Strategy
mongodb               Database driver
mongoose              MongoDB ORM
remark                Markdown parser

Athens Project Limits

notes          64 notes
  name         128 chars
  note         4096 chars
  website      512 chars

Athens Project Premium Perks

Privacy ($1/month) – Make private notes and outlines

More Notes ($2/month) – Note limit is doubled

Avid Writer ($5/month) – Character limits are doubled

Professional ($12/month) – Note limits are g o n e

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published