SkillSwap API

Welcome to the SkillSwap API repository! This repo serves as the backend layer for the AimSet Season 2 Project titled SkillSwap, powering our platform that enables users to exchange skills and services within the community.

Code of Conduct

We value the contributions of all members of our community and strive to provide a positive and inclusive environment. Please review our Code of Conduct to understand the expectations for behavior within our community.

Getting Started

Prerequisites

• Node.js installed
• Yarn installed
• Docker installed and running

Tech Stack

• TypeScript: A superset of JavaScript that adds static typing, enhancing code maintainability and developer productivity.
• Express.js: A fast, unopinionated, minimalist web framework for Node.js, ideal for building robust and scalable APIs.
• TypeORM: An Object-Relational Mapping (ORM) library that simplifies database interactions, allowing developers to work with databases using TypeScript or JavaScript.
• MariaDB: A powerful open-source relational database management system, a fork of MySQL, known for its performance, reliability, and ease of use.
• Redis: An in-memory data structure store, commonly used as a cache or message broker, known for its speed and flexibility.
• Mocha: A feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun.
• ESLint: A pluggable linting utility for JavaScript and TypeScript, ensuring code consistency and identifying potential issues.
• Prettier: An opinionated code formatter that enforces a consistent coding style, promoting code readability and maintainability.
• routing-controllers: A library that simplifies the creation of API controllers in Express by using decorators, making it easier to define routes and handle requests.
• Firebase Auth: Firebase Authentication service for secure user authentication, providing easy integration for user identity and access management.

API Documentation

For detailed information on available endpoints and usage, refer to our API Documentation. TBD

Contributing

We welcome contributions from developers of all skill levels! If you're new to contributing, check out our Contribution Guidelines.

Need Help?

If you have general questions or want to connect with our community, join us on our Discord server. For technical bugs or issues related to the code, please create an issue in this repository.

Happy coding!

Contribution Guidelines