sguillema / ses2-web

ses2-web

Web application for project Software Engineering Studio 2, 2019

Build Setup

# install dependencies
$ npm install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm start

# generate static project
$ npm run generate

For detailed explanation on how things work, checkout Nuxt.js docs.

(Below is Copied From Root)

Software Engineering Studio 2, 2019 Web

This is the repository for the Web Application of Software Engineering Studio 2 2019. This repo contains the application code and a stub server with a testing suite for automated e2e testing (TODO).

The application is built on Nuxt as a PWA.

Table of Contents

• Software Engineering Studio 2, 2019 Web
  • Table of Contents
  • Environment Dependencies
  • Installation & Setup
    • Updating the repository
    • Running the Application for development
  • Acknowledgements

---

Environment Dependencies

• NodeJS - https://nodejs.org/en/download/

---

Installation & Setup

1. Clone the respository

   git clone https://github.com/sguillema/ses2-web
   

2. Navigate to the project root folder and run

   npm install
   

   And once this is done, you can run

   npm run update
   

   This will install all project dependencies and link them together

Updating the repository

1. In the root folder of the project, run

   git pull
   

   Then run

   npm run update
   

   Please ensure that you are on the correct branch. You can see what branch you are on using the git branch command. You can change what branch you are on using the git checkout <branchName> command. Make sure to pull the latest version!

Running the Application for development

Once you have successfully installed the project dependencies, you can run the following command from the project root directory to start the application

npm run dev

You can access the running application through localhost:3000.

Note: This is just for local development.

---

Acknowledgements

• IDE: Visual Studio Code - https://code.visualstudio.com/
• Application Framework: Nuxt - https://nuxtjs.org/
• UI Styling Framework: Vuetify - https://bulma.io/
• Testing Framework: Jest - https://jestjs.io/
• ExpressJS https://expressjs.com/
• Application Deployment (CI/CD): Netlify - https://www.netlify.com/
• Code Formatting: Prettier - https://github.com/prettier/prettier
• Linting: ESLint - https://github.com/eslint/eslint
• Hook Linting - https://github.com/okonet/lint-staged
• Pre-commit Hooks - https://github.com/typicode/husky