api/README.md

Nerdcult API

This repo contains the source and documentation of the nerdcult api.

The source can be found in src and the docs in API.md.

Running

You can run the server with the following command:

export DATABASE_URL=postgres://user:password@host/database
export SMTP_HOST_URL=smtp.yourmailserver.tld
export SMTP_USER=accounts@yourdomain.tld
export SMTP_PASSWORD=password
./nerdcult_api

Implementation Status

• /account
  • /register - POST
  • /verify - POST
  • /authenticate - POST
  • /delete - DELETE
  • /tokens - DELETE
  • /tokens - GET
  • /follow - DELETE (not designed yet)
  • /info - GET (not designed yet)
• /user/{username}
  • /info - GET (not designed yet)
  • /follow - POST (not designed yet)
• /project
  • /create - POST (not designed yet)
  • /info - GET (not designed yet)
  • /join - POST (not designed yet)