Programming-Platform
In-house, Platform Built For Hosting Programming Events, With Various Features.
Please Look At .test.env, Explanation of various secrets below.
SECRET = Cookie Secret
MONGO_USER = Mongo Atlas User
MONGO_PASSWORD = Mongo Atlas User Password (must have admin/owner equivalent)
MONGO_CLUSTER_URL = Mongo Atlas DB cluster Url
MONGO_DATABASE_NAME = Mongo Atlas DB Database Name
SERVER_AUTH_STRING = A Randomly Generated String, must be placed in env of instance of <https://github.com/techsyndicate/Programming-Platform-backend-vm>
SERVER_BACKEND_VM = Ip Of Instance Of <https://github.com/techsyndicate/Programming-Platform-backend-vm>
DISCORD_CLIENT_ID = <https://discord.com/developers/applications> New Application->Oauth2
DISCORD_CLIENT_SECRET = <https://discord.com/developers/applications> New Application->Oauth2
DISCORD_REDIRECT_URI = Discord Redirect URI For Callback, i.e <your-domain>/discord-back/callback
DISCORD_REDIRECT_URI_LOGIN = Discord Redirect URI for Login Callback, in the frontend. (we send a post request to backend, from the frontend so that cookies can be set easily)
GMAIL_EMAIL = Your Gmail Adress For NodeMailer To Use
GMAIL_PASSWORD = Gmail App Password <https://support.google.com/accounts/answer/185833?hl=en>
DISCORD_WEBHOOKS_CRASH_REPORT = Webhook For Crash Reporting
DISCORD_WEBHOOKS_WEB_VITALS = Webhook For Web Vitals
DISCORD_WEBHOOKS_CODE_EXEC_VITALS = Webhook for Code Exec Vitals
FRONT_END_URL = Instance of the /react-app
In various places in the code, the domain may be baked into the application. Search for it in VSC is recommended
Services Used
- Azure Load Balancer|Traffic Manager -> Manage Traffic between multiple servers in various regions.
- Azure VM B1s/Aws t1.micro EC2 -> Virtual Machine (750 free hours), i.e instance of Programming-Platform-backend-vm with pre-installed, GCC,GPP,mono-devel,python3,python2
Twilo Sendgrid -> Sending Emails- Discord Oauth2.0
- Passport Js LocalAuth
- MongoDB -> Storing Data (alternatives azure cosmos DB, google firebase, DynamoDB [Not Natively Supported, But should be easy to migrate.])
- Heroku To Deploy FrontEnd's Backend App the NodeJS, (can use azure or AWS for this too)
Azure AD B2C- NodeMailer
- Netlify to host ReactJS frontend.
Run Application
After Setting in Various Strings as needed in .env, run the following commands to get your app up and running.
npm install
npm build
npm run dev (to run in development)
npm start (to run in production etc.)
Admin Panel Explained
/admin
- Lists All Various Features Available In The Pannel. This is Subject To Change as Needed.
/admin/practise
- Makes A New Practise Section. For example, if you enter Python, it will Make /Practise/Python (ID For Any Use is currently Hackily Either Obtained Through MongoDB directly or Can Be obtained Through Logs In the HTML Page)
/admin/event
- Makes A New Event On The Website, With Start Time And End Time. (ID For Any Use is currently Hackily Either Obtained Through MongoDB directly or Can Be obtained Through Logs In the HTML Page).
/admin/question
- The Question Form, Adds A Question in the practice or the event id submitted. (To Get The quesid, to add test cases or whatever, use the console or MongoDB directly. Hacky Will Fix,
likely/probably not)
/admin/question/testcase
- Adds A TestCase To The Question belonging to the quesid submitted.
/admin/user/all
- Lists All User With All Their Details. If Discord Is Linked, shows button to open it and Has A button to ban users.
/admin/user/ban
- Redirects to /admin/user/ban/:id, id is the given quesid
/admin/user/ban/:id
- Confirm Ban User Associated with given id
We provide no API. Use of any of our services as an API is a violation of our terms and services. And will result in an immediate ban.
Client App Explained
- Moved To ReactApp, i.e react-app