A Progressive Web Application that is a City Guide for Maryville, which offers users with essential city information and also saves time. The application shows all the places to visit in Maryville and users can also suggest new locations.
| Pramod Reddy Gonegari | Narendra Kumar Gunturu | Narsing Rao Nikitha Madhari | Abhilash Ramavaram |
|---|
We are developing the Website with Node.js/Express.js for Back-end, as it is easily scalable and has high performance and Vue.js, Bootstrap for the Font-end. We implemented a CSS Technique called Neumorphism, to give a 3-Dimensional effect to all the components, which is approved by the Client.
The Application development is planned using our Project Board, Issues, Milestones and our weekly progress is communicated through Wiki.
- To run this application, Vue.js, Node.js and npm must be installed.
- Both the Frontend and Backend are configured into this single repository. The entire front-end is developed in a folder named ui.
- Install all the necessary node packages and dependencies, by executing the command, in both the root and ui folders.
npm install
- To start the Backend, from the root folder, run the following command:
npm run dev
- Frontend can be run, by executing the command below, from the ui folder:
npm run serve
- The production ready build, can be generate with the command:
npm run build
- Testing is done using Jest, which is a JavaScript testing framework maintained by Meta, designed and built by Christoph Nakazawa with a focus on simplicity and support for large web applications. It works with projects using Babel, TypeScript, Node.js, React, Angular, Vue.js and Svelte.
- The Test Cases are written in the __tests__ folder, which can be accessed from here. The output code coverage generated after executing all the test cases is directed to Test Coverage Repo.
- From the ui folder, run the following command to execute tests and generate Code Coverage.
npm run test:unit --coverage