SFIGS (Simplified First Issues for Bitcoin Projects) is a platform that curates beginner-friendly tasks within Bitcoin-related open-source projects. It serves as an entry point for developers new to open-source software, allowing them to contribute to well-known Bitcoin projects.
Primary Languages: The SFIGS project primarily utilizes JavaScript, TypeScript, CSS for development tasks.
- Environment Setup: - Begin by copying the environment variables:
cp .env.sample .env.local- Populate the
GITHUB_IDandGITHUB_SECRETfields in the.env.localfile with your OAuth app information from Github. Reference here for creating an OAuth app.
- Dependency Installation: - Install project dependencies using yarn:
yarn install- Starting the Development Server: - Initiate the development server using one of the following commands:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev- Viewing the Result: - Access the output by opening http://localhost:3000 in your preferred web browser. Additional Information:
-
Contributing:
-
Explore available issues categorized as 'Good First Issues' within associated repositories.
-
Fork the repository, create a branch, resolve the issue, and submit a pull request (PR).
-
Guidelines:
-
Follow project-specific guidelines, coding standards, and documentation requirements outlined in the contributing guidelines of each repository.
-
Engage with the project community via designated communication channels.
Special thanks to:
- @exthoisah (https://github.com/Extheoisah) for initiating and maintaining the SFIGS project, setting a welcoming tone, and fostering collaboration within the community.
We extend our gratitude to all contributors for their valuable contributions, support, and efforts in making SFIGS a vibrant and inclusive space for newcomers.