Developer Onboarding Guide - ClearMatch/clear-match GitHub Wiki
Welcome to the team! This guide will help you get set up and ready to contribute effectively.
1. Access Setup
Ensure you have access to all necessary tools and platforms:
- Google Account: Request a company Google account (e.g.,
[email protected]
). - Slack: Get added to the team's Slack workspace for communication.
- Google Drive: Request access to developer-related documents.
- GitHub Repository: Access the project repository at [github.com/dylanclearmatch/clear-match](https://github.com/dylanclearmatch/clear-match). You can use your personal GitHub account or create one specifically for this project.
- Supabase: Obtain access if your role requires interaction with the database.
- HubSpot: Request access if needed for your responsibilities.
- 1Password: Gain access to the team's password manager for secure credentials.
- Figma: Get access to design files and prototypes.
2. Development Environment Setup
Follow these steps to set up your local development environment:
-
Clone the Repository:
git clone https://github.com/dylanclearmatch/clear-match.git cd clear-match
-
Environment Variables:
- Create a
.env.local
file in the root directory. - Retrieve the necessary environment variables from 1Password.
- Add the variables to your
.env.local
file.
- Create a
-
Install Dependencies:
npm install
-
Run the Application:
npm run dev
3. Additional Resources
- Documentation: Refer to the Notion board for comprehensive project documentation.
- Designs: Access Figma for UI/UX designs and prototypes.
- Communication: Use Slack for daily communication and updates.
4. Getting Started
- First Tasks: Check the Notion board for your initial tasks and assignments.
- Meetings: Attend scheduled meetings to sync with the team.
- Support: Don't hesitate to reach out to your mentor or team lead for assistance.
Welcome aboard! We're excited to have you with us. If you have any questions or need further assistance, feel free to ask.