KWoC backend server written in Go.
- Install Go.
- Clone this repository.
- Run
go getin the repository to download all the dependencies. - Create a
.envfile to store all the environment variables. - Set the
DEVenvironment variable totrue. This makes the server use a local sqlite3 database,devDB.db. - Optionally set up Github OAuth to test the log in endpoints. (See also: Endpoints)
- Run
go run .to start the server. - Optionally install SQLiteStudio or any similar tool to help manage the local sqlite3 database file
devDB.db. - Optionally install a tool such as Postman to test the REST API.
See also: File Structure.
- Create a separate file for each model in
models/. - Group the controller functions by their routes.
- Create a separate file for each subroute.
- Clone the repo and
cdinto its directory. - Run the following commands
docker-compose build docker-compose up
NOTE: If you face the following issue with docker-compose.
strconv.Atoi: parsing "": invalid syntax
This is because docker-compose is creating an arbitrary container not in docker-compose.yml and terminating the starting process.
FIX: Use docker-compose-v1 instead of docker-compose.
This project follows the MVC Structure.
main.go: The main file that is executed.models/: Database models.controllers/: Various handlers for HTTP requests.routes/: Definitions of sub-routers.utils/: Middlewares and other common utility functions.scripts/: Extra scripts (unrelated to the usual flow of the web app).docs/: Documentation.
The API exposes the following endpoints. (See also: File Structure)
Files: routes/healthcheck.go, controllers/healthcheck.go.
/healthcheck(GET): Responds with the server and database status./healthcheck/ping(GET): Responds with "Pong!" if the request was successful.
Files: routes/mentor.go, controllers/mentor.go.
/mentor/form(POST): Registers a mentor. The following parameters are required.name: The name of the mentor.email: The email address of the mentor.username: The Github username of the mentor.
/mentor/dashboard(POST): Responds with the information to be displayed on the mentor's dashboard, including a list of projects. The following parameters are required.username: The Github username of the mentor.
/mentor/all(POST): Responds with a list of all the mentors' names and usernames.
Files: routes/oauth.go, controllers/UserOAuth.go.
/oauth(POST): Logs in a user via Github OAuth. (See Github OAuth)
Files: routes/project.go, controllers/project.go.
/project(GET): Responds with a list of all projects./project/add(POST): Adds a new project to the database. See the filecontrollers/project.gofor a list of parameters./project/details(POST): Responds with the details of a project. The following parameters are required.id: The ID of the project in the database.
/project/update(PUT): Updates the details of a project. See the filecontrollers/project.gofor a list of parameters.
Files: routes/stats.go, controllers/stats-overall.go, controllers/stats-project.go, controllers/stats-student.go.
/stats/overall(GET): Responds with the overall statistics./stats/projects(GET): Responds with a list of all projects' statistics./stats/students(GET): Responds with a list of all students' statistics./stats/student/exists/{username}(GET): Responds with "true" if statistics for the given student exist in the database and "false" otherwise./stats/student/{username}(GET): Responds with the stats for the given student./stats/mentor/{username}(GET): Responds with a list of the mentor's project stats.
Files: routes/student.go, controllers/student.go.
/student/form(POST): Registers a student. The following parameters are required.name: The name of the student.email: The email address of the student.college: The institute the student studies at.username: The Github username of the student.
/student/dashboard(POST): Responds with the information to be displayed on the student's dashboard. The following parameters are required.username: The Github username of the student.
/student/bloglink(POST): Adds a link to the student's blog to the database. The following parameters are required.username: The Github username of the student.bloglink: A link to the student's blog.
Environment variables can be set using a .env file (see the .env.template file). The following variables are used.
DEV: When set totrue, uses a local sqlite3 database from a filedevDB.db.DATABASE_USERNAME: The username used to log into the database. (Valid whenDEVis not set totrue)DATABASE_PASSWORD: The password used to log into the database. (valid whenDEVis not set totrue)DATABASE_NAME: The name of the database to log into. (Valid whenDEVis not set totrue)DATABASE_HOST: The host/url used to log into the database. (Valid whenDEVis not set totrue)DATABASE_PORT: The port used to log into the database. (Valid whenDEVis not set totrue)client_id: The client id used for Github OAuth. (See Github OAuth)client_secret: The client secret used for Github OAuth. (See Github OAuth)JWT_SECRET_KEY: The secret key used to create a JWT token. (It can be a randomly generated string)
KWoC uses Github OAuth for log in authentication instead of passwords.
To set up the KWoC server, a Github OAuth application has to be created and the client id and secret has to be set in the environment variables.
- Follow this documentation to create an OAuth app. In the production server, use the
koss-serviceaccount to create the application. - Set the Homepage URL to
https://kwoc.kossiitkgp.organd the authorization callback URL tohttps://kwoc.kossiitkgp.org/oauth/in the production application. - Copy the client ID and the client secret (this should NEVER be made public) and set the
client_idandclient_secretenvironment variables to these values.
Please update this documentation if you make changes to the KWoC backend or any other part of KWoC which affects the backend. Future humans will praise you.