Skip to content

Commit

Permalink
small format changes
Browse files Browse the repository at this point in the history
  • Loading branch information
geokyr committed Sep 17, 2023
1 parent 9bda8f7 commit b1c4eef
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 119 deletions.
75 changes: 0 additions & 75 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,77 +1,2 @@
####################
# C/C++

# Prerequisites
*.d

# Compiled Object files
*.o
*.obj

# Shared objects (inc. Windows DLLs)
*.dll
*.so
*.so.*

# Compiled Static libraries
*.lib

# Executables
*.exe
*.out
*.app

####################
# Python

# Byte-compiled / optimized / DLL files
__pycache__/
*.pytest_cache

# Installer logs
pip-log.txt

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

####################
# Node

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Dependency directories
node_modules/

# Optional npm cache directory
.npm

# Optional REPL history
.node_repl_history

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

####################
# Misc
configuration
.DS_Store
.vscode
.firebase
.firebaserc
*.vpp.*
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# ntua-software-engineering

Semester Project for the [**Software Engineering**](https://www.ece.ntua.gr/en/undergraduate/courses/3205) course, during the 7th semester of the **School of Electrical and Computer Engineering at the National Technical University of Athens**.
Semester Project for the [Software Engineering](https://www.ece.ntua.gr/en/undergraduate/courses/3205) course, during the 7th semester of the School of Electrical and Computer Engineering at the National Technical University of Athens.

## Team 23 - Members
- [**Deligiannis Gerasimos**](https://github.com/GerasimosDel)
- [**Garos Apostolis**](https://github.com/ApostolisGaros)
- [**Kyriakopoulos Georgios**](https://github.com/geokyr)
- [**Tzelepis Serafeim**](https://github.com/sertze)
- [**Vlachakis Nikos**](https://github.com/NikosVlachakis)
- [Deligiannis Gerasimos](https://github.com/GerasimosDel)
- [Garos Apostolis](https://github.com/ApostolisGaros)
- [Kyriakopoulos Georgios](https://github.com/geokyr)
- [Tzelepis Serafeim](https://github.com/sertze)
- [Vlachakis Nikos](https://github.com/NikosVlachakis)

## Project Description

This project's goal is to produce an **information system** that is responsible for the **interoperability on motorway tolls**. This will include a **backend** that will support data management functions between the different toll operators, a **CLI** that will be used to interact with the system, operating as a client on the **backend's REST API** and a **Web Application** that will be used to present the data to the end user, operating as a client on the **backend's REST API**, as well.
This project's goal is to produce an information system that is responsible for the interoperability on motorway tolls. This will include a backend that will support data management functions between the different toll operators, a CLI that will be used to interact with the system, operating as a client on the backend's REST API and a Web Application that will be used to present the data to the end user, operating as a client on the backend's REST API, as well.

## Tools
For the development of the application, we used the following tools:

- Design and architecture: [**Visual Paradigm CE**](https://www.visual-paradigm.com/download/community.jsp)
- Development: [**Node.js**](https://nodejs.org/en), [**Express.js**](https://expressjs.com/), [**React.js**](https://react.dev/), [**argparse**](https://docs.python.org/3/library/argparse.html)
- Database: [**MongoDB**](https://www.mongodb.com/)
- Source code: [**GitHub**](https://github.com/)
- Testing: [**Jest**](https://jestjs.io/), [**pytest**](https://docs.pytest.org/en/7.3.x/)
- Design and architecture: [Visual Paradigm CE](https://www.visual-paradigm.com/download/community.jsp)
- Development: [Node.js](https://nodejs.org/en), [Express.js](https://expressjs.com/), [React.js](https://react.dev/), [argparse](https://docs.python.org/3/library/argparse.html)
- Database: [MongoDB](https://www.mongodb.com/)
- Source code: [GitHub](https://github.com/)
- Testing: [Jest](https://jestjs.io/), [pytest](https://docs.pytest.org/en/7.3.x/)

## Documentation
Includes:
Expand All @@ -31,7 +31,7 @@ Includes:
- StRS Documents - Stakeholders Requirements Specification

## Deployment
- Make sure that you have the latest version of **Node.js** and **MongoDB** installed
- Make sure that you have the latest version of Node.js and MongoDB installed
- Clone the project repository
- Make sure the `mongod` process is running
- To download and install node_modules, navigate to `/backend`, `/api` and `/frontend` and run the following command on each directory:
Expand All @@ -50,17 +50,17 @@ mongorestore -d tldb database

## CLI Instructions

- Install [**python3**](https://www.python.org/downloads/), if not already installed.
- Install [python3](https://www.python.org/downloads/), if not already installed.
- Install the `requests` python package, if not already installed:
```
pip install requests
```
- Add the **CLI** path to your OS `$PATH` to be able to run the **CLI** commands without the prefix `./` for the executables (e.g. as shown below, valid for one session):
- Add the CLI path to your OS `$PATH` to be able to run the CLI commands without the prefix `./` for the executables (e.g. as shown below, valid for one session):
```
PATH=$PATH:/home/username/ntua-software-engineering/cli
```
- Make sure the `mongod` process is running, that you have started the server and that it has connected to the database, as shown in the project's `README.md`.
- Use the **CLI** as specified in the documents, some examples are shown below:
- Use the CLI as specified in the documents, some examples are shown below:
```
se2123 healthcheck
se2123 passesperstation --station AO10 --datefrom 20201101 --dateto 20201231 --format json
Expand All @@ -73,8 +73,8 @@ se2123 admin --passesupd --source ./passes.csv
## API Testing

### Disclaimer
- Due to limitations from the **Jest** testing framework, test suites have to be inside the `/api` folder.
- The `apitesting.test.js` file present in this folder is a copy of the file used for testing that resides in the `/api/test_api` folder. It is **not** used during testing.
- Due to limitations from the Jest testing framework, test suites have to be inside the `/api` folder.
- The `apitesting.test.js` file present in this folder is a copy of the file used for testing that resides in the `/api/test_api` folder. It is not used during testing.

### Instructions
- In the `/api` folder run:
Expand All @@ -85,8 +85,8 @@ npm run test_api
## Backend Testing

### Disclaimer
- Due to limitations from the **Jest** testing framework, test suites have to be inside the `/backend` folder.
- The `db-connection.test` file present in this folder is a copy of the file used for testing that resides in the `/backend/test_backend` folder. It is **not** used during testing.
- Due to limitations from the Jest testing framework, test suites have to be inside the `/backend` folder.
- The `db-connection.test` file present in this folder is a copy of the file used for testing that resides in the `/backend/test_backend` folder. It is not used during testing.

### Instructions
- In the `/backend` folder run:
Expand All @@ -96,7 +96,7 @@ npm run test_backend

## CLI Testing

- Follow the instructions documented on the **CLI's** `README.md`
- Follow the instructions documented on the CLI's `README.md`
- This time, use the `tldb-test` database, by running the following on `/backend`:
```
npm run test_cli
Expand Down
23 changes: 0 additions & 23 deletions frontend/.gitignore

This file was deleted.

File renamed without changes.

0 comments on commit b1c4eef

Please # to comment.