nerdcult
/
api
4
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
The source and documentation of the Nerdcult API.
28 Commits 1 Branch 0 Tags 543 KiB
Rust 98.6%
Dockerfile 1.4%
Go to file
antifallobst 9076a2761a
docs(readme): defined a few api endpoints 		2023-08-18 00:44:08 +02:00
src feat(db): improved layout for accounts table and defined the projects table 2023-08-18 00:16:33 +02:00
.env refactor(db): moved from mariadb to postgresql 2023-08-17 21:09:30 +02:00
.gitignore added gitignore and fixed api specification for `/account/delete` 2023-08-15 20:25:02 +02:00
API.md feat(api): fully implemented the two (GET and DELETE) `tokens` endpoints 2023-08-17 16:40:05 +02:00
Cargo.lock feat(api): added email regex validation on registration 2023-08-17 01:10:01 +02:00
Cargo.toml refactor(db): moved from mariadb to postgresql 2023-08-17 21:09:30 +02:00
README.md docs(readme): defined a few api endpoints 2023-08-18 00:44:08 +02:00

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)