There are 2 ways to run this project during development: using GitHub Codespaces or using a local environment.

If you have a javascript development environment set up already, the local approach is pretty easy. If you just want to get up and going without having to install anything, choose Codespaces.

1. Navigate to the repository in GitHub

2. Click on the "Code" button

   

3. Click on the "Codespaces" tab and create your own environment in your browser!

4. In the Codespace terminal, you can run commands just like you would on a Linux system

5. Run the project with the following command:

   yarn start

1. Clone this repository to your machine

2. Inside the project directory, install the dependencies using Yarn:

   yarn

3. Run the project locally:

   yarn start

4. You can now view the project in your browser at http://localhost:8000

1. Follow the above setup steps
2. Create your project's .mdx file
   1. Create a new folder inside /projects and name it the same as your GitHub handle or organization
   2. Add a new .mdx file to that folder, and give it the name of your public repo. For example,
      • if your project were: github.com/Codesee-io/oss-port
      • you would create: /projects/Codesee-io/oss-port.mdx.
   3. Copy/paste the contents of projects/_template.mdx into that file
3. Fill out the information — most of it is optional, but extremely helpful for potential contributors. If you opt not to include the optional content, delete it from your template.
4. Add a 200x200 image for your organization to your folder, for example, ./projects/distributeaid/da.png
5. Preview your changes by running yarn start
6. When you're ready, open a PR!

Make it easier for contributors to onboard to your project! With a CodeSee Map, they can visualize the entire codebase, with features allowing them to explore system dependencies, add additional context to pull requests, and more.

To add a Map to your project:

1. Sign up for CodeSee Maps (there's no commitment or cost!)
2. Create a Map for your repo following our instructions
3. Set your map to public!
4. Add an entry in your project's template for the Map (see example from Distribute Aid's Shipment Tracker project):

featuredMap:
  url: https://app.codesee.io/maps/public/848e3630-1650-11ec-8bc1-7d4a4822cc27
  description: Get a quick overview of the major areas of our repo

That's it!

The CodeSee Map below is a good way to get familiar with the codebase:

Final tags are up to the maintainers of OSS Port. Your tags may be modified for the benefit of the community and to improve discoverability.

We use title-casing for tags. For example: "First-Timer Friendly, Social Activism, C#, JavaScript".

Open a PR to remove your project folder from this repository.

• Please pin the exact version of dependencies