An open API service indexing awesome lists of open source software.

https://github.com/anshulrgoyal/xunbao-2019

xunbao website for the fest
https://github.com/anshulrgoyal/xunbao-2019

Last synced: 3 months ago
JSON representation

xunbao website for the fest

Awesome Lists containing this project

README

        

# Xunbao-19

Official repository of Xunbao, one of the pre-fest events organized at YMCAUST Faridabad before the annual fest 'Elements Culmyca'.The website include commits from [Sunny singh](https://github.com/sunburn21) and [Ravinder Kumar](https://github.com/thewebsitelevel)

### Installation

You must have [Node.js](https://nodejs.org/) version 10.x installed in order to run this.

#### For node version

```sh
node -v
```

Install the dependencies and devDependencies and start the server.

```sh
$ cd Xunbao-19
$ npm install
$ npm start
```

or
On Linux

```sh
$ chmod +x ./start.sh
$ ./start.sh
```

### Project Structure

```
├── frontend
│   ├── dist
│   │   └── index.html
│   ├── index.js
│   ├── package.json
│   ├── src
│   │   ├── components
│   │   ├── index.js
│   │   └── pages
│   └── webpack.config.js
├── gitignore
├── package.json
├── README.md
└── backend
├── app
│   ├── controller
│   │   ├── admin
│   │   │   └── index.js
│   │   ├── app
│   │   │   └── index.js
│   │   ├── home
│   │   │   └── index.js
│   │   ├── index.js
│   │   ├── leadersboard
│   │   │   └── index.js
│   │   ├── questions
│   │   │   └── index.js
│   │   └── user
│   │   └── index.js
│   ├── helper
│   └── models
│   ├── answer.js
│   ├── index.js
│   ├── question.js
│   └── user.js
├── index.js
└── lib
├── admin
│   └── index.js
├── home
│   └── index.js
├── leaderboard
│   └── index.js
├── questions
│   └── index.js
└── user
└── index.js
```

### Postman Docs

The postman documentation can be found at [Postman Doc](https://documenter.getpostman.com/view/6565104/Rztpp7JS)

### Creating ADMIN

```sh
$ ADMIN_PASSWORD=i_hAte_woRld [email protected] node ./backend/scripts/createAdmin.js
```