https://github.com/philips-labs/fontys-2020-team-abra-cadabra
The general idea of the project is a Question Answer website like stackexchange.com, But the differentiating factor are Experts.
https://github.com/philips-labs/fontys-2020-team-abra-cadabra
Last synced: 7 months ago
JSON representation
The general idea of the project is a Question Answer website like stackexchange.com, But the differentiating factor are Experts.
- Host: GitHub
- URL: https://github.com/philips-labs/fontys-2020-team-abra-cadabra
- Owner: philips-labs
- Created: 2020-09-11T10:52:32.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-21T16:21:34.000Z (over 2 years ago)
- Last Synced: 2025-01-18T05:30:50.031Z (9 months ago)
- Language: HTML
- Homepage:
- Size: 90.1 MB
- Stars: 4
- Watchers: 7
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Abra Cadabra - A Questions and Answers Web App
## Table of contents
- [About the Project](#about-the-project)
- [Features](#features)
- [Landingpage](#landingpage)
- [List of all subjects](#list-of-all-subjects)
- [Subject page](#subject-page)
- [Filter questions in a subject](#filter-questions-in-a-subject)
- [Accounts](#accounts)
- [Apply for expert](#apply-for-expert)
- [Answer a question as an expert](#answer-a-question-as-an-expert)
- [Answer a question as a user](#answer-a-question-as-a-user)
- [Ask questions in different subjects](#ask-questions-in-different-subjects)
- [Reporting](#reporting)
- [Tags](#tags)
- [Up and down voting](#up-and-down-voting)
- [Admin dashboard](#admin-dashboard)
- [Admin ban a user](#admin-ban-a-user)
- [Admin verify expert requests](#admin-verify-expert-requests)
- [Admin check out reports](#admin-check-out-reports)
- [Admin manage subjects](#admin-manage-subjects)
- [How to run it Locally](#how-to-run-it-locally)
- [Dev / test accounts](#dev--test-accounts)
- [Admin](#admin)
- [Expert](#expert)
- [Users](#users)
- [Session](#session)
- [Development](#development)
- [Prerequisites](#prerequisites)
- [Set Up for developement](#set-up-for-developement)
## About the Project
This project is in collaboration with **Fontys** and **Phillips**. It's a school project, about making an "ethical" web application, with a question and answers in different subjects. When an user has a question, they can visit our website, create an account and ask their question. Alternatively, they could use the tools we provided to search and filter the questions already asked, in order to find an answer to their question, if it was laready asked.
Additionally, users can become experts on a subject, if they provide credentials to prove their knowledge. Administrators, manage the approval process through an admin panel, where they can also review flagged questions and answers to determine if they are inappropriate and should be deleted, manage users, subjects and get graphical representation based on statistics of what's popular around the website.
## Features
#### Landingpage
#### List of all subjects
#### Subject page
#### Filter questions in a subject
#### Accounts
#### Apply for expert
#### Answer a question as an expert
#### Answer a question as a user
#### Ask questions in different subjects
#### Reporting
#### Tags
#### Up and down voting
#### Admin dashboard
#### Admin ban a user
#### Admin verify expert requests
#### Admin check out reports
#### Admin manage subjects
## How to run it Locally
1. Clone this git repository
2. Create a aspnet cert in the cert folder
```bash
cd Abracadabra
cd certs
dotnet dev-certs https -ep aspnetapp.pfx -p password
```
2. Run the docker compose file
```bash
cd ..
docker-compose build
docker-compose -f docker-compose.yml up -d
```
3. When the docker-compose is up.
>Admin dashboard: http://localhost:3001
>Website: http://localhost:3000
>API URL: https://localhost:5000
### Dev / test accounts
#### Admin
>Email: admin@gmail.com
>Password: Password@1
#### Expert
>Email: expert@gmail.com
>Password: Password@2
#### Users
>Email: user@gmail.com
>Password: Password@0
### Session
If you restart the back-end you should delete your browers local storage since the back-end uses a in memory database for Dev purposes.
## Development
This section is about how to set up the project locally to be ready for development
### Prerequisites
* An IDE (Recommended Visual Studio and Visual Studio Code)
### Set Up for developement
1. Clone the repository
```bash
git clone https://github.com/philips-labs/fontys-2020-team-abra-cadabra
```
2. Install dependencies for the Web App and run it
```bash
cd Abracadabra/abracadabra_web_app
npm install
npm run dev
```
3. Install dependencies for the Admin Panel and run it
```bash
cd Abracadabra/abracadabra_admin_panel
npm install
npm run dev
```
4. Run the API
```bash
cd Abracadabra/AbracadabraAPI/AbracadabraAPI
dotnet run
```
5. Create a file named .env.local with the following content (replace "http://localhost:5000" with the address your api is running on)
```JS
# API
NEXT_PUBLIC_API_URL=http://localhost:5000
```
*look at the localhost port presented during the start-up to find the API url*