Skip to content

abderrahimlaribi/tinome-hack

Repository files navigation

Tinome

A collaborative platform designed specifically for ESI (École Supérieure d'Informatique) students to connect and find partners for academic projects, homework assignments, and hackathons.

🎯 Purpose

Tinome aims to facilitate collaboration among ESI students by providing a platform where they can:

  • Find partners for homework assignments
  • Connect with fellow students for project collaborations
  • Form teams for hackathons
  • Build a network of like-minded developers and tech enthusiasts

🚀 Features

  • ⚡️ Fast development with Vite
  • ⚛️ React 18 with modern features
  • 🔄 React Query for efficient data fetching
  • 🎨 Prettier for consistent code formatting
  • 📝 ESLint for code quality
  • 🐶 Husky for git hooks
  • 📦 Conventional commits with commitlint

🛠️ Tech Stack

  • React - A JavaScript library for building user interfaces
  • Vite - Next Generation Frontend Tooling
  • React Query - Powerful asynchronous state management
  • ESLint - Code linting utility
  • Prettier - Code formatter
  • Husky - Git hooks made easy
  • Commitlint - Lint commit messages

📦 Installation

  1. Clone the repository:
git clone https://github.com/abderrahimlaribi/tinome-hack.git
cd tinome
  1. Install dependencies:
npm install

🚀 Development

To start the development server:

npm run dev

The application will be available at http://localhost:5173

🏗️ Build

To create a production build:

npm run build

To preview the production build:

npm run preview

🧪 Code Quality

The project uses several tools to maintain code quality:

  • ESLint for code linting
  • Prettier for code formatting
  • Husky for git hooks
  • Commitlint for conventional commits

Run the linter:

npm run lint

📝 Commit Guidelines

This project follows Conventional Commits specification. Commit messages should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Types include:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation changes
  • style: Code style changes
  • refactor: Code refactoring
  • test: Adding or modifying tests
  • chore: Maintenance tasks

🤝 Contributing

We welcome contributions from ESI students! If you'd like to contribute to Tinome:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'feat: add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

👥 Team

Tinome is developed by and for ESI students. Join us in making collaboration easier for the ESI community!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published