2024-10-17 19:33:24 +02:00
|
|
|
# Malackathon-frontend
|
2024-10-17 11:57:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
> Malackathon CyberBokeron frontend.
|
|
|
|
|
|
|
|
![Bulma](https://img.shields.io/badge/Bulma-0.9.4-00D1B2?style=flat-square)
|
|
|
|
![SolidJS](https://img.shields.io/badge/SolidJS-1.0-blue?style=flat-square)
|
2024-10-17 19:33:24 +02:00
|
|
|
![License](https://img.shields.io/badge/license-AGPLv3)
|
2024-10-17 11:57:43 +02:00
|
|
|
|
2024-10-17 12:00:59 +02:00
|
|
|
## **Contents**
|
2024-10-17 11:57:43 +02:00
|
|
|
|
|
|
|
- [Description](#description)
|
|
|
|
- [Features](#features)
|
|
|
|
- [Requirements](#requirements)
|
|
|
|
- [Installation](#installation)
|
|
|
|
- [Usage](#usage)
|
|
|
|
- [Contributing](#contributing)
|
|
|
|
- [License](#license)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
## **Description**
|
|
|
|
|
2024-10-17 19:33:24 +02:00
|
|
|
Frontend made using [SolidJS](https://www.solidjs.com/) and [Bulma](https://bulma.io/) as frameworks.
|
2024-10-17 11:57:43 +02:00
|
|
|
|
|
|
|
## **Features**
|
|
|
|
|
|
|
|
- ⚡️ Fast thanks to SolidJS
|
|
|
|
- 🎨 Clear and responsive desing thanks to Bulma
|
|
|
|
- 📦 Minimal configuration
|
|
|
|
|
|
|
|
## **Requirements**
|
2024-10-17 19:33:24 +02:00
|
|
|
Before proceeding, make sure you have the following installed:
|
2024-10-17 11:57:43 +02:00
|
|
|
|
2024-10-17 12:00:20 +02:00
|
|
|
- [Node.js](https://nodejs.org/) v14 or higher
|
2024-10-17 19:33:24 +02:00
|
|
|
- [npm](https://www.npmjs.com/)
|
2024-10-17 11:57:43 +02:00
|
|
|
|
|
|
|
## **Installation**
|
|
|
|
|
|
|
|
Follow this steps to set up the project locally:
|
|
|
|
|
|
|
|
1. Clone the repo:
|
|
|
|
```bash
|
2024-10-17 12:02:14 +02:00
|
|
|
git clone https://openbokeron.uma.es/gitea/CyberBokeron/Malackathon-frontend.git
|
2024-10-17 11:57:43 +02:00
|
|
|
```
|
|
|
|
2. Go to project directory:
|
|
|
|
```bash
|
|
|
|
cd Malackathon-frontend
|
|
|
|
```
|
|
|
|
3. Install dependencies:
|
|
|
|
```bash
|
|
|
|
npm install
|
|
|
|
```
|
|
|
|
## **Usage**
|
|
|
|
|
|
|
|
To run server locally:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
npm run dev
|
|
|
|
```
|
|
|
|
|
2024-10-17 12:38:34 +02:00
|
|
|
Go to `http://localhost:8080` in your browser to see the app.
|
2024-10-17 11:57:43 +02:00
|
|
|
|
|
|
|
### **Commands**
|
|
|
|
|
|
|
|
- `npm run build`: Compile the project
|
|
|
|
- `npm run dev`: Start development server.
|
|
|
|
- `npm run format`: Format code using Prettier.
|
|
|
|
- `npm run lint`: Run linter to keep the code clean.
|
|
|
|
|
|
|
|
|
|
|
|
## **Contributing:**
|
|
|
|
|
|
|
|
If you'd like, you can contribute by doing the following steps:
|
|
|
|
|
|
|
|
1. Fork the project
|
|
|
|
2. Create new branch (`git checkout -b feature-nueva-funcionalidad`).
|
|
|
|
3. Commit changes (`git commit -am 'Añadir nueva funcionalidad'`).
|
|
|
|
4. Push your branch (`git push origin feature-nueva-funcionalidad`).
|
|
|
|
5. Open a pull request.
|
|
|
|
|
|
|
|
## **License**
|
|
|
|
|
|
|
|
This project is licensed under [AGPLv3](LICENSE).
|
|
|
|
|
|
|
|
---
|