Skip to content

This website acts as a Homepage for Kelp. It contains some examples and explanations while also providing a platform for distributing Kelp Plugins and Kelp Extensions

License

Notifications You must be signed in to change notification settings

KelpFramework/kelp-website

Repository files navigation

Seapipe - KelpFramework Homepage

Developed by Davis_Software © 2020-2021

Join the DISCORD for exclusive updates, feature voting, etc. Share and download free plugins with the community

What is Kelp?

Visit the Kelp repo for more info Additionally you can also take a look at this Wiki page.

What does this website do?

This website acts as a Homepage for Kelp. It contains some examples and explanations while also providing a platform for distributing Kelp Plugins (link pending) and Kelp Extensions (link pending).

Visit it here (link pending)


Running the webserver

You need Python3 in order to run the server

  • Clone the Repository into a folder
  • Create a virtual environment if you want
  • Run pip3 install -r requirements.txt to install all required modules
  • Configure port and host (and database if you want) in configuration.py
  • You might want to change stuff like application_host, etc. in __init__.py
  • Run the webserver with python3 main.py

Will there be documentation?

Yes, there will be documentation on how to use front-end features. The backend also receives some documentation at the most important points, but please understand that not every function/class will be affected by this.

  • "I want to write some documentation": You are all welcome to write documentation on API, etc. However, these will also have to be maintained by you!

Contributing

If you want to contribute, you are of course welcome to work on any subject you like! However, there will be no guarantee that any of your work will make it into the public release. If you are not sure where to start, you can look at the table below. It shows features which are in development or ideas that could be implemented.

You can also request a feature! For more info you should read this section.

One last thing before you start! Be sure to read the contribution guidelines

Feature Implemented Planed State Description
Extension Proposition if requested Users are able to propose Extensions which will be tested and maybe released.
Plugin Voting (no date) Users can vote if they like a plugin or not. This will affect listing and users will be able to sort by such parameters.
Markdown Overhaul done Better markdown styles on all pages which use it.
Remember Logins done Add options for remembering user login

more features will be added here if requested

You can also have a look at the Trello board!


Bug reports and Feature requests

If you have bug reports, ideas, or need support feel free to open a new issue here on GitHub. Optionally you can also try fixing the bug yourself, however, this may proof to be quite difficult as there is no documentation.

About

This website acts as a Homepage for Kelp. It contains some examples and explanations while also providing a platform for distributing Kelp Plugins and Kelp Extensions

Topics

Resources

License

Stars

Watchers

Forks