Skip to content

A project for presenting my professional work to the world in a fancy single page application made with Vue.js, Express and MongoDB. The whole project is well documented on how I built everything.

License

Notifications You must be signed in to change notification settings

JustalK/PORTFOLIO

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Alt text

Last version Travis Coverage Status Maintainability Status

A project for presenting my professional work to the world in a single page application. As a fullstack developer, I have coded both side of the application. The frontend has been made with Vue.js and the backend is made with Express and MongoDB. The entire project is compiled through Webpack.

The entire project follow the official convention for JS. It's checked everyime I compile the project by EsLint. Also, the project is checked by travis and the test of Ava for checking the continuity. Finally, the robustness of the project is assured by Coveralls who checked the coverage of the test.

Flowchart

Alt text

Database ERD

The database is centered around the articles/projects. It's the main purpose of this project :

Alt text

Development cycle

I am developing following an easy to understand cycle. This way I am sure to not destroy everything that has been done with a new functionnality :

Alt text

Installation

The easiest and fatest way to install this project is through docker-compose with this command :

npm run docker

If you do not have docker on your machine, you will need to have node and a mongodb on your machine, you can install all the dependencies of the project by running this command at the root of the project :

$ npm install

Seeding

I am using mongo-seeding for automatically populating the database with the right information. You can run it by using this command :

npm run seed

Build

For building the dev or build version

$ npm run dev
$ npm run build

Watching

For watching the project while developing

$ npm run watch
$ npm run watch-server

The project can be access at the port 8080 by default : http://localhost:8080/

Alt text

The documentation of the API (swagger) can be access at this url : http://localhost:8080/api/documentation/index.html

Alt text

Server

For running the server with the last build :

$ npm run server

License

MIT - Copyright © JUSTAL Kevin

About

A project for presenting my professional work to the world in a fancy single page application made with Vue.js, Express and MongoDB. The whole project is well documented on how I built everything.

Topics

Resources

License

Stars

Watchers

Forks