The BScout app is working towards being a directory and idea sharing platform to help bitcoiners get connected and build things together. Built on Next.js and MongoDB Atlas.
₿scout is a passion project 🧡 by and for bitcoiners (initiated and led by Finsko, Bayani and Crispy in Australia 🇦🇺). As we are all strapped for time, we would love for anyone who is interested to get involved, whether you're a junior or experienced developer, a designer, project manager.
You can contribute in multiple ways:
- Join the BScout Alpha chat group.
- Submit issues that you see with the alpha version.
- Submit pull requests on code that could be improved or changed. (here's a how-to). Hint: if you feel like a beginner in this stack, you can look for the 'good first issue' label in the Issues section
- Design user experiences or user interfaces for features.
- ... and there are lots of other ways you could help, you can email us at [email protected]!
- Production (alpha) - https://alpha.bscout.io
- Development (alpha) - https://dev.bscout.io *Our blog is currently at https://bscout.io
These instructions are for anyone who would like to solve problems and contribute to the Bscout application.
In order to develop locally, you will need the following:
- nodejs
- npm, yarn or pnpm - read comparison
- Fork this repository to your own.
- Clone/download your forked version to your local computer.
git clone https://github.com/dragon-foobar/bscout.git
- On your local machine, navigate to inside the cloned repository.
cd bscout
- Install dependencies (replace yarn your package manager)
yarn install
- Set up environment variables. Instructions can be found in
.env.example. You need to duplicate this file and call it.env. For the MongoDB url, you will need to create your own instance of a MongoDB. You can use the free MongoDB Cloud Atlas version designed for developers. Learn more here. - Now that you've installed dependencies and you have your environment variables set up. You can run the development server. All commands can be found in
package.jsonyarn dev - Once this is working, next steps are to explore the code, make changes and commit those using git. You'll need to use an code editor such as Visual Studio Code. If you are not sure about how to use git, here's a tutorial.
Below is a list of technologies used to produce and run this app. If you are familiar with using React but not nextjs, you can their docs in the link or follow a tutorial like this
🤟