HEAD

EVAT-Web-Application

EVAT is a mobile application designed to streamline vehicle management. This repository contains the DevOps codebase for the EVAT web application.

EVAT Mobile Application

Table of Contents

• Introduction
• Features
• Installation
• Usage
• Development
• Contributing
• Code Quality
• Git Etiquette
• License
• Contact

Introduction

The EVAT mobile application allows users to find the nearest vehicle charging station efficiently and is designed to streamline vehicle management. This repository contains the DevOps codebase for the EVAT web application.

Features

• User Registration
• User Login
• Add Vehicle
• View Vehicle Details

Installation

To get started with the project, follow these steps:

1. Clone the repository:

   git clone https://github.com/yourusername/EVAT-web-application.git

2. Navigate to the project directory:

   cd EVAT-web-application

3. Install dependencies:

   npm install

Usage

To start the development server, run:

npm start

Development

To run the front end project locally, from the root project run:

cd front_end_project && npm run start

To run the back end project locally, from the root project run:

cd back_end_project && npm run start

To launch both the node server and react app, run:

npm run devall

Note: npm run devall isn’t working currently. To launch the node server alone, run:

npm run server

This can be used by API developers to test their API through POSTMAN. Development should follow the Feature branch git workflow. Important: Never commit directly to main. When pulling the latest from GitHub, you may need to run npm install if any packages were added or removed in past commits. If you are experiencing errors unrelated to the code you are writing (or before writing any), try running npm install.

Contributing

We welcome contributions! Please follow these steps to contribute: Fork the repository. Create a new branch:

git checkout -b feature/your-feature

Commit your changes:

git commit -m 'Add some feature'

Push to the branch:

git push origin feature/your-feature

Code Quality

Linting

Code quality is enforced by ESLint, which is configured as a custom eslint plugin shared across the entire project in eslintrc.js. Each package/app requires its own .eslintrc.js file.

• Components, component directories, component files, and stories all use PascalCase / UpperCamelCase.
• Variables and functions use camelCase.
• Single quotes for strings.
• Do not use string interpolation for CSS classes.
• Do not use CSS-in-JS, StyledComponents, or Emotion CSS.

Git Etiquette

Branching

Branches are used for isolated feature development and should always branch from the source they intend to merge into. This means that a branch created from main must always end up in main.

Using the example branches of main -> feature-1 -> feature-2…
❌ Do not merge feature-1 into main before feature-2 is merged.
❌ Do not merge feature-2 directly into main, only its parent branch.
✅ Do branch feature-2 from main since it should not depend on feature-1.
Note: If it’s entirely necessary to merge feature-1 before feature-2, ensure that no manual commits are made in feature-2 between the last commit & merge commit to main of feature-1.

Commit Messages

There are no hard constraints imposed on commit messaging. Instead, the following guidelines show a best-practice approach to producing consumable commit messaging. The preferred format for a commit message looks like this. Note that only the body is required:

# format...
"type?(scope?): body..."

# examples...
"fixed some issue"
"fix: fixed some issue"
"fix(US-123): fixed some issue"
"fix(component): fixed some issue"

Commit Types

• type refers to what kind of commit is being made. Some example values are:

  • --build // related to build processes
  • --chore // small cleanup activities or other pedantry
  • --ci // related to continuous integration activities
  • --docs // documentation work
  • --feat // feature work
  • --fix // bugfixes or hotfixes
  • --perf // performance tuning & optimization
  • --refactor // code refactoring
  • --revert // reverting previously committed changes
  • --style // styling changes
  • --test // changes to tests

• scope provides context to the commit type, most commonly a MS planner ticket or some project name.

• body refers to the bulk of the commit message, which can break up into header and footer sections delimited by newlines.

  • A header is the body section on the first line of the commit message.
  • A footer is entered a full newline separated from the header and may contain any length of UTF-8 content.

APIs

Here are the APIs that will be used in the EVAT Mobile application:

User Management

• User Registration API
• User Login API
• User Profile API

Vehicle Management

• Add Vehicle API
• View Vehicle Details API
• Update Vehicle API
• Delete Vehicle API

Charging Station

• Find Nearest Charging Station API
• Real-time Charging Station Availability API

Maps Integration

• Google Maps API (for displaying maps and locations)
• Geolocation API (for getting the user’s current location)

Backend

• MongoDB API (for database operations)

License

For the license, the MIT License is a popular choice for open-source projects. MIT License

Copyright (c) 2024 Chameleon-company

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 768657f (Readme.md)