# se-faq

**Repository Path**: billchen2k/se-faq

## Basic Information

- **Project Name**: se-faq
- **Description**: QA platform for Software Engineering freshmen in ECNU.
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-28
- **Last Updated**: 2021-10-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# se-faq

A guide and simple QA platform for Software Engineering / Computer Science freshmen in East China Normal University.

## Techstack:

- client: vue, vuetify, axios
- server: mongodb, express, mongoose
- deployment: docker

## Project deployment

```
apt install git npm
npm install npm@latest -g
npm install n -g
n latest
npm install yarn
git clone https://github.com/BillChen2K/se-faq
cd se-faq
cd client && yarn && yarn build && cd ..
```

Remember to change the contents in `client/static/constants` before `build`.

Copy `client/Dockerfile.sample` as `client/Dockerfile`; Copy `server/Dockerfile.sample` as `server/Dockerfile`; Copy `docker-compose.yml.sample` as `docker-compose.yml`:

```bash
cp client/Dockerfile.sample client/Dockerfile
cp server/Dockerfile.sample server/Dockerfile
cp docker-compose.yml.sample docker-compose.yml
```

Then set password for mongodb. Change `server/Dockerfile`:
```
ENV MONGO_USER=youruser
ENV MONGO_PASS=youruser
```

Then change `docker-compose.yml`, set corresponding value for database initialization.

```
MONGO_INITDB_ROOT_USERNAME: youruser
MONGO_INITDB_ROOT_PASSWORD: youruser
```

If you need the admin comments directly from the web page , change the `FAQ_AUTH` value in `server/Dockerfile`, this will be the password of your admin panel.

To access admin panel, you should add `admin=1` after your URL, such as `http://localhost?admin=1`.

You can change anything else as you like in these files. For example, the volumes mapping, the ports, etc.

Lastly
```
curl -fsSL https://get.docker.com -o get-docker.sh || sh
sudo curl -L "https://github.com/docker/compose/releases/download/1.26.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

docker-compose up --build
```

Or simply `chmod +x deploy.sh && ./deploy.sh`.

All kinds of contribution is welcomed.