Welcome to StudyCrew's GitHub repository! This repository serves as the central hub for www.studycrew.world's source code, assets, and content.

Mission

StudyCrew is committed to making education accessible, collaborative, and engaging through innovative learning platforms. Our vision is to provide every student with the resources and community they need to reach their full potential. If you have any questions or inquiries, feel free to reach out to us at [email protected].

Contributors

A huge thanks to these amazing people who are helping build a world with better education!

Interested in joining us? Just comment on an issue you’d like to work on or ask any questions you have in our Discord community. We always appreciate new contributors!

Features

The first feature we’ll develop is study groups, which includes a Q&A board, a group chat, and a section for shared materials. Additionally, the first version includes a personal dashboard, a user profile page, and a settings page. Feel free to check out the Figma prototype of StudyCrew 0.1! For future versions, we consider implementing tutoring, learning paths, shared flashcards, and more.

Getting Started

To begin, follow these steps:

1. Clone the repository:

git clone https://github.com/studycrew/studycrew

Setting up Supabase

StudyCrew uses Supabase as its primary data storage. Ensure you have a local instance or a free Supabase subscription.

Setting up Authentication with Supabase

For authentication, StudyCrew utilizes Supabase. To set up your local instance, you'll need a Supabase account. Once you've created an account, obtain your credentials and place them in the env.local file:

NEXT_PUBLIC_SUPABASE_URL=https://iqbtyidkfhmqokxopxhf.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6ImlxYnR5aWRrZmhtcW9reG9weGhmIiwicm9sZSI6ImFub24iLCJpYXQiOjE3MjA0NTI4NDgsImV4cCI6MjAzNjAyODg0OH0.eo6MVgRbXbdpdUlj4YQo4NJ6D0kE2HRQaLO4VOAOMd4

Running the Project Locally

Using Docker

This project is Dockerized for easy development and deployment. Follow the instructions below to get started.

Make sure you have Docker installed and running on your system.

Quick Start

1. Fork this Repository

2. Clone the Repository to local:

   git clone <your-repository-url>
   cd <your-repository-name>

3. Build the Image:

   # (Development)
   docker build . --target development -t studycrew_test:dev
   # (Production)
   docker build . --target production -t studycrew_test:prod

4. Run the Image:

   # (Development)
   docker run -v .:/usr/src/app -p 3000:3000 --name studycrew_test studycrew_test:dev
   # (Production)
   docker run -p 3000:3000 --name studycrew_prod studycrew_test:prod

5. Access the Application: Open your browser and navigate to http://localhost:3000 to see the running application.

To stop the container, run docker stop studycrew_test or docker stop studycrew_prod respectively.

Without Docker

1. pnpm i the required dependencies.

2. pnpm dev to launch the development server.

Contributing

Interested in contributing? Check out our contribution guide to learn how you can get involved and contribute to StudyCrew's development.

When you find an issue that you want to work on, just leave a comment so we can assign it to you! Feel free to tag @JacobHeldt so we notice your comment faster.

Before contributing please read the style guidelines from the Figma documentation carefully.

If you have to create a new component, please study existing components so these are kept consistent with the rest of the project.

If you are unsure about anything, just ask! We are more than happy to help and would love to have you are part of the community. 😊

Creating Issues

We encourage you to report bugs or suggest enhancements by creating a new issue. To help us address your issue efficiently, please follow these steps:

1. Before creating a new issue, check if it has already been reported or discussed.
2. Provide all relevant information and write a clear, descriptive title. You can take inspiration from existing issues.

Developer Hours

StudyCrew hosts regular meetings for contributors and team members to discuss upcoming changes, planned updates, and overall strategy. These 'developer hours' are held on our Discord server, where specific timings will be announced.

Join Our Community

Join our Discord community for discussions, support, and more!

Thank you for exploring our repository! We're excited to welcome you to our community.