https://github.com/complexlity/stackdocs
https://github.com/complexlity/stackdocs
docusaurus2 reactjs
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/complexlity/stackdocs
- Owner: Complexlity
- Created: 2023-02-27T00:16:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T05:28:15.000Z (over 1 year ago)
- Last Synced: 2025-03-27T04:41:34.383Z (about 1 year ago)
- Topics: docusaurus2, reactjs
- Language: JavaScript
- Homepage: https://stackdocs.app
- Size: 1.47 MB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
[](#contributors-)
Table of Contents
## About The Project
[![StackDocs Screen Shot][product-screenshot]](https://stackdocs.netlify.app)
StackDocs is a web application that provides stackies links to all (past and present) [StackUp](https://app.stackup.dev/) campaigns and quests in documentation format.
### Built With
This project was put together using the following
- [![React][react.js]][react-url]
- [![Docusaurus][docusaurus]][docusaurus-url]
## Getting Started
Follow the steps below to setup this project locally
### Pre-requisites
You need to have the following installed on your machine
- [Nodejs and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [git](https://git-scm.com/downloads)
### Setup
1. Clone the repo
```sh
git clone https://github.com/Complexlity/stackdocs.git
```
2. Install NPM packages
```sh
npm install
```
3. Start the program
```sh
npm start
```
After the process completes, open [localhost](http://localhost:3000) in your browser
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better or you would like to improve the campaigns and quests documentation, please fork the repo and create a pull request. Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
Ensure to read and understand the instructions in the [contributing guide](/CONTRIBUTING.md) before making any contributions.
## Contact
Complexlity - [@website](https://complexlity-personal-portfolio/netlify.app#contact/)
Project Link: [@Stack Docs](https://github.com/Complexlity/stackdocs)
## Acknowledgments
- [Build Documentation sites with react and markdown](https://docusaurus.io)
- [Generate Project README ](https://github.com/othneildrew/Best-README-Template)
- [Img Shields](https://shields.io)
[product-screenshot]: static/img/project-screenshot.png
[docusaurus]: https://img.shields.io/badge/Docusaurus-2e8555?style=for-the-badge&logo=docsdotrs&logoColor=white
[docusaurus-url]: https://docusaurus.io/
[react.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[react-url]: https://reactjs.org/
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Complexlity
💻 📖 🚧
AugustHottie
📖
Raghavan
📖
Add your contributions
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
