Skip to content

Complexlity/stackdocs

Repository files navigation

All Contributors


Logo

StackDocs

Linking You to StackUp


Live Preview · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. Contact
  5. Acknowledgments

About The Project

StackDocs Screen Shot

StackDocs is a web application that provides stackies links to all (past and present) StackUp campaigns and quests in documentation format.

(back to top)

Built With

This project was put together using the following

  • React
  • Docusaurus

(back to top)

Getting Started

Follow the steps below to setup this project locally

Pre-requisites

You need to have the following installed on your machine

Setup

  1. Clone the repo
    git clone https://github.com/Complexlity/stackdocs.git
  2. Install NPM packages
    npm install
  3. Start the program
  npm start

After the process completes, open localhost in your browser

(back to top)

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 before making any contributions.

(back to top)

Contact

Complexlity - @website

Project Link: @Stack Docs

(back to top)

Acknowledgments

(back to top)

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Complexlity
Complexlity

💻 📖 🚧
AugustHottie
AugustHottie

📖
Raghavan
Raghavan

📖
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!