README
¶
End Of APUSH Project
This is the code for a final project from my APUSH class in school. As such, it is no longer being developed. The product is an encrypted messaging service that also has some explanation of the different types of cryptography between 1945 and present day. It has a full user account system with built in messaging. It is written in Golang and JavaScript with the frontend using React.
Configuration
You can use either JSON or YAML as the configuration language. Example for YAML, and for JSON. Below are the defaults for each configuration value:
| Key | Description | Value |
|---|---|---|
| server.host | What interface to have the server listen | 127.0.0.1 |
| server.port | What port to have the server listen on | 8080 |
| database.host | The host where the database is running | 127.0.0.1 |
| database.port | The port where the database is running | 5432 |
| database.ssl | Use SSL for the connection | disable |
| database.username | Username to connect with | postgres |
| database.password | Password that authenticates the user | postgres |
| database.database | Database to connect to | postgres |
| database.wipe | Clear the database before each run | false |
API
There are 7 different distinct routes each with at least 1 REST method to accept it. Some also have query or path parameters to go with them. All routes are prefixed with the path /api unless otherwise specified.
Users
POST /users - create a new user
GET /users/search - fuzzy search for other users
GET /users/{username} - retrieve your user information
PUT /users/{username} - update your user information
DELETE /users/{username} - delete your own account
Authentication
POST /auth/login - generate a new authentication token for the rest of the API
GET /auth/logout - revoke the current authentication token, effectively logging the user out
Messaging
POST /messages - send a new message to another user
GET /messages - get a list of all messages sent to you
GET /messages/{id} - get a specific message information
Documentation
¶
There is no documentation for this package.
Source Files
Directories