forked from codinasion-archive/codinasion-monorepo
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Documentation (codinasion-archive#4480)
- Loading branch information
1 parent
8830009
commit 3fce14f
Showing
28 changed files
with
592 additions
and
172 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,27 @@ | ||
| * @harshraj8843 | ||
| # These owners will be the default owners for everything in | ||
| # the repo. Unless a later match takes precedence, | ||
| * @harshraj8843 | ||
|
|
||
|
|
||
| # Code owners for 'program' folder | ||
| /program/program/ @codinasion/program | ||
|
|
||
|
|
||
| # Code owners for Website(s) and api(s) | ||
| /apps/ @codinasion/web-dev @harshraj8843 | ||
|
|
||
|
|
||
| # Code owners for Github Bot(s) | ||
| /github-bots/ @codinasion/github-bot @harshraj8843 | ||
|
|
||
|
|
||
| # Code owners for npm package(s) | ||
| /packages/npm/ @codinasion/npm @harshraj8843 | ||
|
|
||
|
|
||
| # Code owners for README and translations | ||
| **/README*.md @codinasion/README @harshraj8843 | ||
| **/readme*.md @codinasion/README @harshraj8843 | ||
|
|
||
|
|
||
| # End of CODEOWNERS file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../../LICENSE.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,116 @@ | ||
| This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). | ||
| <h1 align="center">Codinasion API</h1> | ||
|
|
||
| ## Getting Started | ||
| <div align="center"> | ||
|
|
||
| First, run the development server: | ||
| Get Codinasion data, through our API. | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| # or | ||
| yarn dev | ||
| # or | ||
| pnpm dev | ||
| ``` | ||
| [](https://api.codinasion.org "Codinasion API") [](https://github.com/codinasion/codinasion/blob/master/LICENSE.md "MIT License") [](https://github.com/sponsors/codinasion) | ||
|
|
||
| Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
| <a href="https://vercel.com/?utm_source=codinasion&utm_campaign=oss" target="_blank"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/powered-by-vercel.svg" alt="Powered By Vercel" width="170"> | ||
| </a> | ||
|
|
||
| You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. | ||
| </div> | ||
|
|
||
| This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. | ||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| ## Learn More | ||
| ## API Endpoints | ||
|
|
||
| To learn more about Next.js, take a look at the following resources: | ||
| | Endpoint | Description | | ||
| | -------------------------------------------------------------------------------------- | ---------------------------------- | | ||
| | [`/github/contributors`](https://api.codinasion.org/github/contributors) | List of Codinasion contributors | | ||
| | [`/github/members`](https://api.codinasion.org/github/members) | List of Codinasion team members | | ||
| | [`/github/repos`](https://api.codinasion.org/github/repos) | List of Codinasion repositories | | ||
| | [`/program`](https://api.codinasion.org/program) | List of programs | | ||
| | [`/program/[slug]`](https://api.codinasion.org/program/program-name) | Program details | | ||
| | [`/program/languages`](https://api.codinasion.org/program/languages) | List of languages used in programs | | ||
| | [`/program/languages/[language]`](https://api.codinasion.org/program/languages/python) | Language specific list of programs | | ||
|
|
||
| - [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. | ||
| > **Note** Replace `[slug]` with the program name, and `[language]` with the language name. | ||
| You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! | ||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| ## Deploy on Vercel | ||
| ## How to setup | ||
|
|
||
| The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. | ||
| 1. Fork this repository | ||
| 2. Clone the forked repository | ||
| 3. Install dependencies | ||
|
|
||
| Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. | ||
| ```bash | ||
| pnpm install | ||
| ``` | ||
|
|
||
| 4. Build all projects (for **1st time** only) | ||
|
|
||
| ```bash | ||
| pnpm all | ||
| ``` | ||
|
|
||
| 5. Run the development server | ||
|
|
||
| ```bash | ||
| pnpm run dev --filter api | ||
| ``` | ||
|
|
||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| <br> | ||
|
|
||
| See full documentation about `Turbo Repo` at https://turbo.build/repo | ||
|
|
||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| ## Contributing | ||
|
|
||
| If you're looking for a way to contribute, you can scan through our existing issues for something to work on. | ||
| We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read our [Contributing Guide](https://github.com/codinasion/codinasion/blob/master/CONTRIBUTING.md) on how you can take part in improving Codinasion. | ||
|
|
||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| ## Join us in discussions | ||
|
|
||
| We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing, join us in the [discussions](https://github.com/orgs/codinasion/discussions). | ||
|
|
||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| <br> | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td> | ||
| <img align="left" src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/octocat.png" width="190"> | ||
| <h3>Thanks for contributing :purple_heart:</h3> | ||
| <ul> | ||
| <li>Thanks for all your contributions and efforts</li> | ||
| <li>We thank you for being part of our :sparkles: commUnity :sparkles: !</li> | ||
| </ul> | ||
| <img width="900" height="0"> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| <br/> | ||
|
|
||
| <p align="center"> | ||
| Made with 💖 by Codinasion | ||
| </p> | ||
|
|
||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../../LICENSE.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,98 @@ | ||
| This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). | ||
| <h1 align="center">Codinasion</h1> | ||
|
|
||
| ## Getting Started | ||
| <div align="center"> | ||
|
|
||
| First, run the development server: | ||
| Collaborate, Create, Innovate: Together with Open Source ❤️ | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| # or | ||
| yarn dev | ||
| # or | ||
| pnpm dev | ||
| ``` | ||
| [](https://codinasion.org "Codinasion") [](https://github.com/codinasion/codinasion/blob/master/LICENSE.md "MIT License") [](https://github.com/sponsors/codinasion) | ||
|
|
||
| Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
| <a href="https://vercel.com/?utm_source=codinasion&utm_campaign=oss" target="_blank"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/powered-by-vercel.svg" alt="Powered By Vercel" width="170"> | ||
| </a> | ||
|
|
||
| You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. | ||
| </div> | ||
|
|
||
| This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. | ||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| ## Learn More | ||
| ## How to setup | ||
|
|
||
| To learn more about Next.js, take a look at the following resources: | ||
| 1. Fork this repository | ||
| 2. Clone the forked repository | ||
| 3. Install dependencies | ||
|
|
||
| - [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. | ||
| ```bash | ||
| pnpm install | ||
| ``` | ||
|
|
||
| You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! | ||
| 4. Build all projects (for **1st time** only) | ||
|
|
||
| ## Deploy on Vercel | ||
| ```bash | ||
| pnpm all | ||
| ``` | ||
|
|
||
| The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. | ||
| 5. Run the development server | ||
|
|
||
| Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. | ||
| ```bash | ||
| pnpm run dev --filter codinasion | ||
| ``` | ||
|
|
||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| <br> | ||
|
|
||
| See full documentation about `Turbo Repo` at https://turbo.build/repo | ||
|
|
||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| ## Contributing | ||
|
|
||
| If you're looking for a way to contribute, you can scan through our existing issues for something to work on. | ||
| We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read our [Contributing Guide](https://github.com/codinasion/codinasion/blob/master/CONTRIBUTING.md) on how you can take part in improving Codinasion. | ||
|
|
||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| ## Join us in discussions | ||
|
|
||
| We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing, join us in the [discussions](https://github.com/orgs/codinasion/discussions). | ||
|
|
||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| <br> | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td> | ||
| <img align="left" src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/octocat.png" width="190"> | ||
| <h3>Thanks for contributing :purple_heart:</h3> | ||
| <ul> | ||
| <li>Thanks for all your contributions and efforts</li> | ||
| <li>We thank you for being part of our :sparkles: commUnity :sparkles: !</li> | ||
| </ul> | ||
| <img width="900" height="0"> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> | ||
|
|
||
| <br/> | ||
|
|
||
| <p align="center"> | ||
| Made with 💖 by Codinasion | ||
| </p> | ||
|
|
||
| <div align="center"> | ||
| <img src="https://raw.githubusercontent.com/codinasion/codinasion/master/assets/rainbow-hr.png" alt="rainbow hr" width="100%" height="70%"> | ||
| </div> |
Oops, something went wrong.