MetaKGP Website

Website for metaKGP to display their projects
No demo yet · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
   • Project Structure
3. Roadmap
4. Contributing
5. Contact
6. Acknowledgments

About The Project

We need a landing page for MetaKGP that

1. "sells" the projects
2. Describes MetaKGP

The current landing page is here which looks janky so "metakgp.org" just redirects to the wiki instead.

Our goal is to incorporate some modern web design principles. However directly using UI frameworks defeats the purpose of the learning culture of metaKGP which is why we will be writing our own css and designing stuff from scratch.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

• install dependencies and set up frontend

  # Install dependencies using  pnpm
  pnpm install
  pnpm start
  

(back to top)

Project Structure

.//
├── public/
├── src/
│   ├── app/
│   ├── assets/
│   ├── components/
│   ├── sections/
│   ├── index.css
│   └── index.tsx
├── README.md
└── tsconfig.json

Roadmap

• Migrate from npm to pnpm
• Design some fire project cards
• Add react-router to setup the various pages
• Add the projects sections and relatedly the projects page
• Add the contribute page
• Add the DC++ page :)
• Add a Footer
• Use an API to get metaKGP stats (look into organisation stats github apis)

See the open issues for a full list of proposed features (and known issues).

(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, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". 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

Top contributors:

(back to top)

Contact

• Project Link: https://github.com/Majestic9169/metakgp-website
• Slack Workspace: Join here

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Best-README-Template
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• React Icons

(back to top)