Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ishivanshgoel/paradox-2021
Website for online treasure hunt conducted under IEEE Computer Society of VIT Chennai.
https://github.com/ishivanshgoel/paradox-2021
bootstrap create-react-app cryptic-hunt expressjs ieee ieeecomputer mongodb mongoosejs nodejs paradox-2021 react-redux react-router reactjs redux
Last synced: 4 months ago
JSON representation
Website for online treasure hunt conducted under IEEE Computer Society of VIT Chennai.
- Host: GitHub
- URL: https://github.com/ishivanshgoel/paradox-2021
- Owner: ishivanshgoel
- License: mit
- Created: 2021-02-17T14:22:02.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-27T12:59:13.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T12:04:39.973Z (4 months ago)
- Topics: bootstrap, create-react-app, cryptic-hunt, expressjs, ieee, ieeecomputer, mongodb, mongoosejs, nodejs, paradox-2021, react-redux, react-router, reactjs, redux
- Language: JavaScript
- Homepage: https://paradox21.tech/
- Size: 8.39 MB
- Stars: 6
- Watchers: 3
- Forks: 9
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Paradox-2021
PARADOX - A two-day online cryptic hunt organized by IEEE Computer Society of VIT Chennai.
- [ Installation Setup ](#Installation)
- [ File Structure ](#File-Structure)
- [ How to Contribute ](#Contributing)
- [ The Team ](#The-Team)
## Installation
- Clone the repository
- Add all the files required for [ setting up the project. ](#Setting-Up-credentials-and-adding-secrets)
- Install all the [ dependencies ](#Installing-dependencies)
- Start [ backend server ](#Start-backend-server)
- Start the [ frontend development server ](#Start-Frontend-server)
## File Structure
---
### Setting Up credentials and adding secrets
| File name | Location | Description |
| ------------- | ------------- |------------- |
| .env | root | secret string/ codes used on server side.
| Constants.json | /client/src/Helper/Constants.js| secret string/ codes used on client side.|
- Refer to these [ file structures ](#File-Structures)
### Installing dependencies
- In the root directory ```npm install``` this installs all the dependencies required on the server-side.
- Move to client directory ```cd client```
- In Client Directory ```npm install``` this installs all the dependencies required on the client-side.
### Start backend server
- In root directory ```npm start```
- The node server will start at port ```5000```
- ``` Express app listening at port 5000 Connected to database!! ``` message in the console indicates that the backend server is up and running successfully on your local machine.
### Start Frontend server
- Move to the client directory by writing ```cd client``` in the console and give another command ```npm start``` to start the server.
### File Structures
- .env
```
# database uri
DB_URI =
# admin verification token
ADMIN_TOKEN =
# user token
TOKEN_SECRET =
# mailer setup
EMAIL =
PASSWORD =
SERVICE =
SUBJECT = PARADOX 2021 - Registration Successful!
```
- Constants.js
```js
// do not push this file to git
const EVENTDATE = 2 // starting date of event
const ADMINTOKEN = 'admin_token'
export default {}
export { EVENTDATE, ADMINTOKEN }
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## The Team
### Event Coordinator
- Samank Gupta
- Tanay Bhadula
### Developers
- Shivansh Goel
- Tejas Vaichole
- Sanika Kulkarni
- Prabhat Singh
- Praneeth Sethumadhavan
### Graphic Designer
- Prathiba Narayan