RUNNING WITH
- Node.js >= 10
- Angular CLI >= 8
- MongoDB
- Yarn
- Docker (optional)
quizz-app/ # → Root Application
├── docker/ # → DockerFile images
│ └── backend/ # → backend DockerFile
├── e2e/ # → End to End tests Folder
├── server/ # → backend root folder
│ ├── src/ # → Backend Source Folder
│ │ ├── api/ # → Backend API Folder
| │ │ ├── controllers/ # → Controllers
| │ │ ├── middlewares/ # → Middlewares
| │ │ ├── models/ # → Mongo models folder
| │ │ ├── routes/ # → Routes folder
| │ │ ├── services/ # → Service layer folder
| │ │ └── validators/ # → Payload validators
│ │ ├── config/ # → Configuration Folder
│ │ ├── data/ # → Seeds and Database script location
│ │ ├── docs/ # → documentation location
│ │ └── utils/ # → Helpers Folder
│ └── test/ # → Backend Unit Tests
├── src/ # → Frontend root folder
│ ├── app/ # → Frontend source folder
│ │ └── layout/ # → layout folder
│ ├── assets/
│ ├── environments/ # → Frontend environments variables
│ └── themes/
├── .babelrc # → Babel configuration file
├── .dockerignore # → Files to be ingnored on docker build
├── .editorconfig # → Files to be ingnored on docker build
├── .env.docker # → Docker env file exemple
├── .env.example # → exemple env file
├── .eslintrc # → Es linter configuration
├── jest.config.js # → node.js dependencies and scripts
├── package.json # → node.js dependencies and scripts
├── README.md # → ME :smile:
├── tsconfig.app.json
├── tsconfig.json
├── tsconfig.spec.json
├── tslint.json # → Typescript linter definition
└── yarn.lock
Create .env
file in the root project from .env.example
and edit default parameters
Edit parameters in .env.docker
- Run
yarn
from the theme directory to install dependencies
yarn start
— Compile and optimize backend & frontendyarn start:dev
— launch backend & frontend in dev modeyarn lint
— Run linter on backend & frontendyarn build
— Compile and optimize the backend & frontend files concurrently
Run yarn test
to execute the unit tests via Jest & Chai.
Run yarn e2e
to execute the end-to-end tests via Protractor.
Comming Soon
Comming Soon
- List Quizz API
- Create Quizz API
- Submit Quizz API
- List Quizz Front
- Submit Quizz Front
- Authentication
- Registration
- Integrate Keystone 5
- Launch With Docker