Malackathon-frontend/README.md

Malackathon-frontend

Malackathon CyberBokeron frontend.

**Contents **

• Description
• Features
• Requirements
• Installation
• Usage
• Contributing
• License

---

Description

Frontend made using SolidJS and Bulma as frameworks.

Features

• ⚡️ Fast thanks to SolidJS
• 🎨 Clear and responsive desing thanks to Bulma
• 📦 Minimal configuration

Requirements

Before proceeding, make sure you have the following installed:

• Node.js v14 o superior
• npm o yarn

Installation

Follow this steps to set up the project locally:

1. Clone the repo:

   git clone 
   

2. Go to project directory:

   cd Malackathon-frontend
   

3. Install dependencies:

   npm install
   

Usage

To run server locally:

npm run dev

Go to http://localhost:3000 in your browser to see the app.

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.

---