Skip to content

JulieBaret/mini-project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

About the project  •  Getting Started  •  Usage  •  Test  •  Documentation

Mini-project developed for an application.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Test
  5. Documentation

✨ About the project

This simple app offers a table of training exercises related to cybersecurity and the correct use of new technologies. The user can click "Go!" to complete one training exercise and will randomly win or lose. Easy, right ?

Screencapture:

app demo

Built with:

  • NPM
  • React
  • TailwindCSS

🛠 Getting Started

Clone down this repository.

Prerequisites:

You will need node and npm installed globally on your machine.

Installation:

npm install


🥋 Usage

To launch the project, you'll first have to start the server with this command:

npm start

Then, you'll be able to visit the app at:

localhost:3000

Folder structure:

.
├── src .   » Project source code
|       |
|       ├── layouts   » Layouts of the projet (Header, Body, Footer)
|       |
|       └── components    » Several components including ui elements such as Button, Category Column and Status Column
|       
├── public    » Public assets
|
├── assets    » Logo and screencapture of the project for the README.md file
|
├── README.md   » Current file
|
├── package-lock.json
|
├── package.json
|
├── tailwind.config.js    » Tailwind configuration file
|
└── .gitignore

🧪 Test

To run tests, run the following command:

npm test

Then, press: a

It will launch the following tests:

  1. the home page should render a heading, a logo and a table;
  2. the "Go!" button should be clickable;
  3. the table should have four columns (one for button included);
  4. the table should have the correct column headers titles;
  5. clicking the "Go!" button should decrease the number of trainings to start;
  6. clicking the "Go!" button should increase the number of trainings won or defeat;

📚 Documentation

About

Mini-project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors