If you would like to join our community, please join our fun and exciting discord.
We are always looking for new contributors. There are many different ways to contribute to NearBeach, for example;
- Donating via github sponsorships or our patreon
- Bug testing
- Bug fixing
- Writing Documentation
- Writing new components or functionality for NearBeach
- Refactoring Code, i.e. making it more efficient
- Updating Code, i.e. updating libraries
- Marketing NearBeach
- Supplying feedback on NearBeach, i.e. improvements and feature requests
and many many more. Join our community on discord to see what you can do
Please read our code of conduct here.
NearBeach is an open source project management system, that has been built using both the frameworks; Django and VueJS.
Each different module/componet in NearBeach are called Objects. The following objects currently exist;
- Organisations
- Customers
- Requirements
- Requirement Items
- Projects
- Tasks
- Request for Changes
- Kanban Boards
Each object shall have it's own folder structure within the respected location, i.e. /views/projects.
Please follow the instructions in our documentation: Setting up local dev environment
Like most projects, there are some overhead costs. Every single dollar that we get will go towards;
- Cloud hosting costs
- Software costs
- Administration costs
- Freelance costs (i.e. hiring help like designers)
We are being transparent with all our costs and will try and provide a yearly cost breakdown every 6 months.
Bug reporting is a very important role for NearBeach. During Hacktoberfest, you are more than welcome to submit issues.
NearBeach currently has a number of easy tasks/issues located on our Deepsource - https://deepsource.io/gh/robotichead/NearBeach/issues.
NearBeach currently has a number of easy tasks/issues located on our CodeClimte - https://codeclimate.com/github/robotichead/NearBeach/issues
Please fork NearBeach, git your changes in and then submit a simple pull request.
When submitting a pull request, please fill out the template appropriately. We have flagged NearBeach's repository with Hacktoberfest, so any accepted pull requests WILL count towards Hacktoberfest.
Not all pull requests will be accepted.
Our documentation is hosted on readthedocs. If you would like to contribute to the documentation, you will be able to find the files within /docs