⚡️⚡️⚡️ Self-hosted collaborative bookmark manager to collect, read, annotate, and fully preserve what matters, all in one place.
TypeScript bookmarkbookmark-managercollaborationnextjsreact-nativeread-it-laterself-hostedtypescript
Added contribution guide.
Danieldc2ab7ff29de
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.mdindex e69de29b..4219a8d3 100644--- a/.github/CONTRIBUTING.md+++ b/.github/CONTRIBUTING.md@@ -0,0 +1,16 @@+# How to contribute+> **For questions/help, feature requests and bug reports please create an [issue](https://github.com/Daniel31x13/link-warden/issues) (please use the right lable).**++First off, I'm really glad you're reading this and thank you for taking the time to contribute! 👍++1. Confirm your planned implementation fit into our project [features](https://github.com/Daniel31x13/link-warden#features) (wether it's adding a new feature or improving our existing code).++2. Open an issue with your planned implementation to discuss.++3. Check in with me before starting development to make sure your work wont conflict with or duplicate existing work.++4. Commit, push, and submit a PR and wait for review feedback.++5. Have patience, don't abandon your PR! We love contributors but we don't always have time to respond to notifications instantly. If you want a faster response, DM me on [Twitter](https://twitter.com/daniel31x13).++Thanks again! <3diff --git a/README.md b/README.mdindex ce90c406..e0c9de63 100644--- a/README.md+++ b/README.md@@ -23,7 +23,7 @@ The objective is to have a self-hosted place to keep useful links in one place,- [x] Lazy loading support (for better performance).- [x] Set multiple tags to each link.-### Other planned features+### Other planned Features(These are not 100% guaranteed, they're just idea's.)- [ ] Add time stamps to links.- [ ] Browser extenstions.@@ -33,14 +33,17 @@ The objective is to have a self-hosted place to keep useful links in one place,- [ ] Sidenav.- [ ] A design logo.-> **To make a pull request please take a look at our [contributing guidelines](.github/CONTRIBUTING.md).**-## Setup### Linux/MacOS-1. Make sure the MongoDB database and collection is up and running.+1. Make sure your MongoDB database and collection is up and running.2. Edit `/src/config.js` accordingly.3. Head to the main folder using terminal and run: `(cd api && npm install) && npm install --legacy-peer-deps` for the dependancies.4. Run `npm start` to start the application.++## LinkWarden Development+All contributions are welcomed! Please take a look at [how to contribute](.github/CONTRIBUTING.md).++> **For questions/help, feature requests and bug reports please create an [issue](https://github.com/Daniel31x13/link-warden/issues) (please use the right lable).**\ No newline at end of file