Skip to content

Latest commit

 

History

History
129 lines (94 loc) · 4.98 KB

README.md

File metadata and controls

129 lines (94 loc) · 4.98 KB
Raw

gssoc github-header-image

GitHub commit activity   GitHub forks   GitHub Repo stars   Bitbucket open issues   GitHub Issues or Pull Requests   GitHub last commit

Lupo Skill

Lupo Skill is an open-source platform for sharing skills through events. Users can both host and join events to share their expertise and learn from others. This platform is built using React.js with TypeScript, Firebase for backend services, and React-Bootstrap for UI components.

Features

  • Host Events: Share your skills and knowledge by hosting events on the platform.
  • Join Events: Explore a variety of events hosted by others to learn new skills.
  • User Profiles: Customize your profile to showcase your skills, interests, and upcoming events.
  • Event Management: Manage your hosted events, including editing details and sending updates.
  • Real-time Updates: Receive real-time notifications and updates for events you're hosting or attending.
  • Responsive Design: Enjoy a seamless experience across devices with a fully responsive design.
  • Microblogging and Social Networking to promote created events (UPCOMING): People will be able to promote there events in microbloging and social networking feature.

Technologies Used

  • React.js: A JavaScript library for building user interfaces.
  • TypeScript: A typed superset of JavaScript that improves code quality and developer experience.
  • Firebase: Provides backend services such as authentication, database, and real-time communication.
  • React-Bootstrap: A UI library for building responsive and mobile-friendly components.

📌 Tech Stack

  • Firebase
  • ReactJs
  • TypeScript

Contributing to Lupo Skill

Visit Contributing.md for contribution guide.

You can find the video for setup here

Using Issue Templates

  1. Always use the provided issue templates when creating new issues.
  2. Choose the appropriate template based on the type of issue you are reporting (bug, feature request, etc.).
  3. Fill out all the required fields in the template to provide clear and concise information.

Reporting Issues

When reporting a new issue, please provide the following details:

  • Description of the issue.
  • Steps to reproduce (if applicable).
  • Expected behavior.
  • Actual behavior.
  • Any relevant screenshots or error messages.

Making Pull Requests

If you're submitting a pull request, please:

  • Describe the changes made and the reason for the changes.
  • Reference any related issues by using keywords such as "Fixes #<issue_number>" in your pull request description.

Code of Conduct

Please review our Code of Conduct before contributing. We expect all contributors to adhere to the code of conduct to maintain a positive and inclusive community environment.

Getting Started

  1. Fork the repository: Start by forking the Lupo Skill repository to your own GitHub account.
  2. Clone the repository: Clone the forked repository to your local machine using Git.
git clone https://github.com/your-username/lupo-skill.git
  1. Navigate to the project directory:
cd lupo-skill
  1. Install dependencies: Use npm to install the project dependencies.
npm install
  1. Set up Firebase:
  • Create a Firebase project on the Firebase console.
  • Configure Firebase authentication, Firestore database(rtdb), and storage (remeber to edit the rules).
  • Update Firebase configurations in the project. in firebaseConf.ts
  1. Run the website
npm run start

Contributors: