This project is a part of the course API development at Medieinstitutet, Stockholm, Sweden
Inside the documentation directory you can find the first draw made in "mirro" where I tried to visualize
the user flow of the app.
There is also a reflection.md file that is part of the assignment and atm its in Swedish only
(Swedish is the course language so thats the main reason for that.)
The reflection.md is mainly to point out "why" certain decisions were made during the process,
if it was to solve a issue or if any issues appeared because of them and how it was solved.
*DISCLAIMER* This project uses send grid for login with email and magic link. You need to setup your own .env with credentials for the login to work. *DISCLAIMER*
To get the app started for demo just follow the steps listed below.
One note about TinyMCE warning, it shows upp if there is no api-key provided in the Editor tag
that can be found inside the two components "CreateDocument.vue" and "EditDocumentModal.vue" inside
Frontend/src/components.
This app requires the use of a MySQL database. During development I used MAMP to create and handle my database.
With MAMP you can admin your database with "phpMyAdmin", a form of GUI.
Inside the documentation directory/map there is a exported file of a sample MySQL database to get you started.
For ease of use I recomend that you have nodemon installed on your system.
cd into the map "backend"
npm install
to connect to the database
nodemon start
Now you should get a success message saying: Connected to the database with ID "ID to the database"
cd in to the map "frontend"
npm install
then to run app in localhost
npm run dev
ctrl + click the url link that is provided in the terminal.
- Git
- Github
- Mirro
- VS Code
- Vue.js 3
- Pinia & vue router
- Vite
- TinyMCE for vue 3
- CSS 3
- prettier
- ESlint
- Express
- Cors
- ENV
- SQL querys
- sendGrid
- JWT
- MySQL
- MAMP
- PHPmyAdmin GUI