Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rishiosaur/oss
👥 Buildin' a collection of profiles!
https://github.com/rishiosaur/oss
Last synced: 5 days ago
JSON representation
👥 Buildin' a collection of profiles!
- Host: GitHub
- URL: https://github.com/rishiosaur/oss
- Owner: rishiosaur
- License: mpl-2.0
- Created: 2021-01-01T03:30:40.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-06T17:45:40.000Z (almost 2 years ago)
- Last Synced: 2023-05-16T23:20:17.049Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://oss.rishi.cx
- Size: 757 KB
- Stars: 6
- Watchers: 2
- Forks: 34
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 📚 Open Source Profiles!
A minimal showcase of the developers that came to the Git & GitHub workshop at Hack the North 2021!
# Profiles
To add yourself to the list, you'll need to modify `profiles.json` - the API reads data from that specific file as a rudimentary persistent data source.
`profiles.json` merely contains an array of `Profile`s, which are defined to be:
```typescript
interface Profile {
name: string // Your name
github?: string // Github username
twitter?: string // Twitter username
insta?: string // Instagram username
description: string // Minimal description about you!
profileUrl: string // Image of yourself (you can host on imgur.com or some other hosting site)
}
```
To add yourself to the website, you'll need to add another object to the array listed in `profiles.json`.
To make sure your PR has the highest change of being reviewed, you must:
1. Create an issue using the "New Profile" template and fill it out using your proposal.
2. Edit `profiles.json` according to your own profile on your fork, and make a PR mentioning your corresponding issue.
3. Fix any merge conflicts, iteration procedures and/or build errors (your PR will be merged as soon as all checks pass & one of the moderators approves it).
# Development - If you're interested in going a bit deeper!
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
## Cloning
After forking the repository, run the following to get it onto your machine:
```
git clone https://github.com//oss.git
cd oss
git status
```
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/import?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.