Abdur-rahmaanJ / oss-port

OSS Port

OSS Port

Running this project locally

1. Clone this repo

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

Contributing

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

How to list your own project

1. Follow the above setup steps
2. Create a new folder inside /projects and name it the same as your GitHub handle or organization
3. Add a new .mdx file using the name of your public repo
4. Copy/paste the contents of projects/_template.mdx into that file
5. 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.
6. Add a 200x200 image for your organization to your folder, for example, ./projects/distributeaid/da.png
7. Preview your changes locally
8. When you're ready, open a PR!

Adding a CodeSee Map to your project listing

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. 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

How to remove your project from OSS Port

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

Notes

• Please pin the exact version of dependencies