An open API service indexing awesome lists of open source software.

https://github.com/hichamecode/p9_billed

Projet 9 - formation openClassRooms - dev React JS
https://github.com/hichamecode/p9_billed

Last synced: about 1 year ago
JSON representation

Projet 9 - formation openClassRooms - dev React JS

Awesome Lists containing this project

README

          

# Billed 👔

Billed is a project focused on debugging and implementing tests for an employee expense management application.

![JavaScript](https://img.shields.io/badge/JavaScript-ES6+-yellow?logo=javascript) ![Express.js](https://img.shields.io/badge/Express.js-000000?logo=express) ![Jest](https://img.shields.io/badge/Jest-testing-red?logo=jest) ![HTML5](https://img.shields.io/badge/HTML5-E34F26?logo=html5&logoColor=white) ![CSS3](https://img.shields.io/badge/CSS3-1572B6?logo=css3&logoColor=white)

---

## 📖 Description

This project involves working on an existing codebase for **Billed**, an application designed to streamline the process of managing and validating employee expenses. The main focus is on **debugging** the application and **implementing a comprehensive test suite** to ensure its reliability and functionality.

## 🎯 Objectives

- **Debug** existing features in the application
- Implement **unit tests** and **integration tests**
- Achieve **high test coverage** for both frontend and backend code
- Improve the overall **reliability** and **performance** of the application
- Practice **test-driven development** (TDD) methodologies

---

## 🛠️ Technologies

- **JavaScript**
- **Jest** (for testing)
- **Express.js** (backend)
- **HTML5/CSS3**
- **Git**

---

## ⚙️ Installation

To set up the project locally, follow these steps:

1. Ensure you have **Node.js** installed (version 14 or higher).
2. Open your terminal and clone the repository:

```bash
git clone https://github.com/hichamecode/p9_Billed.git
```

3. Navigate to the project directory:

```bash
cd p9_Billed
```

4. Install the dependencies:

```bash
npm install
```

5. Start the development server:

```bash
npm run dev
```

---

## 🌟 Features

- **Employee Expense Submission**: Allows employees to submit their expenses for review.
- **Admin Review Process**: Provides an interface for administrators to review and approve/reject expenses.
- **Automated Testing**: Includes a suite of **unit** and **integration tests**.
- **Debugging Tools**: Implements various debugging techniques to identify and fix issues.

---

## 🗂️ Project Structure

The project is organized as follows:

```bash
p9_Billed/
├── src/
│ ├── app/ # Application logic
│ ├── views/ # Frontend views
│ ├── controllers/ # Backend controllers
│ └── models/ # Data models
├── tests/
│ ├── unit/ # Unit tests
│ └── integration/ # Integration tests
└── public/ # Static assets
```

## Contribution

This project was developed as part of the OpenClassrooms Web Developer training program. Contributions are not currently being accepted.

## License

This project is for educational purposes within the OpenClassrooms curriculum and does not have a specific open-source license.