From 1e3af2e9e200e1c467d193467efc9b1779b21be7 Mon Sep 17 00:00:00 2001 From: pablohashescobar Date: Wed, 11 Jan 2023 02:02:31 +0530 Subject: [PATCH] docs: added self hosting docs and updated Readme --- README.md | 43 +++++++++------ apps/docs/src/components/Header.jsx | 2 +- apps/docs/src/pages/self-hosting.mdx | 81 +++++++++++++++++++++++++++- 3 files changed, 107 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index bc3166313..33d7d4a13 100644 --- a/README.md +++ b/README.md @@ -2,41 +2,50 @@

- Plane Logo + Plane Logo

-
-Plane helps you track your issues, epics, and product roadmaps. Take off and experience the world of project management like never before. - -

Discord - +Discord

-# Getting Started +
+Plane is an open-source project planning tool that is designed to help individuals and teams streamline their issues, sprints, and product roadmaps. It is easy to use and can be accessed by anyone, making it an ideal choice for a wide range of projects and organizations. +

+ +> Plane is still in its early days, not everything will be perfect yet, and hiccups may happen. Please let us know of any suggestions, ideas, or bugs that you encounter on our [Discord](https://discord.com/invite/29tPNhaV) or GitHub issues, and we will use your feedback to improve on our upcoming releases. + +## Getting Started Visit https://app.plane.so to get started with Plane. -# Documentation +## Documentation -Coming soon. +For full documentation, visit [docs.plane.so](https://docs.plane.so/) -# Community +To see how to Contribute, visit [here](https://github.com/makeplane/plane/blob/master/CONTRIBUTING.md). + +## Status + + +- [x] Early Community Previews: We are open-sourcing and sharing teh development version of Plane +- [ ] Alpha: We are testing Plane with a closed set of customers +- [ ] Public Alpha: Anyone can sign up over at [app.plane.so](https://app.plane.so). But go easy on us, there are a few hiccups +- [ ] Public Beta: Stable enough for most non-enterprise use-cases +- [ ] Public: Production-ready + +## Community The Plane community can be found on GitHub Discussions, where you can ask questions, voice ideas, and share your projects. To chat with other community members you can join the [Plane Discord](https://discord.com/invite/q9HKAdau). -Our Code of Conduct applies to all Plane community channels. +Our [Code of Conduct](https://github.com/makeplane/plane/blob/master/CODE_OF_CONDUCT.md) applies to all Plane community channels. -# Contributing +## Security -Please see our contributing.md. - -# Security - -If you believe you have found a security vulnerability in Plane, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports. Email security@plane.so to disclose any security vulnerabilities. +If you believe you have found a security vulnerability in Plane, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports. Email security@plane.so to disclose any security vulnerabilities. \ No newline at end of file diff --git a/apps/docs/src/components/Header.jsx b/apps/docs/src/components/Header.jsx index 40f60f327..62433df4c 100644 --- a/apps/docs/src/components/Header.jsx +++ b/apps/docs/src/components/Header.jsx @@ -70,7 +70,7 @@ export const Header = forwardRef(function Header({ className }, ref) {
diff --git a/apps/docs/src/pages/self-hosting.mdx b/apps/docs/src/pages/self-hosting.mdx index 7fa23f85d..6d789f40f 100644 --- a/apps/docs/src/pages/self-hosting.mdx +++ b/apps/docs/src/pages/self-hosting.mdx @@ -1,3 +1,82 @@ # Self Hosting Plane -Coming soon. +import { Heading } from '@/components/Heading' + + + Plane is still in its early days, not everything will be perfect yet, and + hiccups may happen. Please let us know of any suggestions, ideas, or bugs that + you encounter on our [Discord](https://discord.com/invite/A92xrEGCge). + + + + Requirements + + +1. Git +2. Docker +3. Docker-compose + + + Project set-up + +1. Clone the code + + ```bash + git clone --depth 1 https://github.com/makeplane/plane + ``` + +2. Change Directory + + ```bash + cd plane + ``` + +3. Move `env.example` to `.env` in the `apiserver` directory and `apps/app` + + ```bash + mv.env.example.env + ``` + +4. Add all the variables - (the below are the compulsory variables) + + Frontend - `apps/app/.env` + + ```bash + NEXT_PUBLIC_API_BASE_URL = '<-- endpoint goes here -->' + NEXT_PUBLIC_GOOGLE_CLIENTID = '<-- google client id goes here -->' + NEXT_PUBLIC_GITHUB_ID = '<-- github id goes here -->' + NEXT_PUBLIC_APP_ENVIRONMENT = '<-- production | development -->' + ``` + + Backend - `apiserver/.env` + + ```bash + # Backend + SECRET_KEY="<-- django secret -->" + EMAIL_HOST="<-- email smtp -->" + EMAIL_HOST_USER="<-- email host user -->" + EMAIL_HOST_PASSWORD="<-- email host password -->" + + AWS_REGION="<-- aws region -->" + AWS_ACCESS_KEY_ID="<-- aws access key -->" + AWS_SECRET_ACCESS_KEY="<-- aws secret acess key -->" + AWS_S3_BUCKET_NAME="<-- aws s3 bucket name -->" + + SENTRY_DSN="<-- sentry dsn -->" + WEB_URL="<-- frontend web url -->" + + GITHUB_CLIENT_SECRET="<-- github secret -->" + + DISABLE_COLLECTSTATIC=1 + DOCKERIZED=1 + ``` + +5. Run + + ```bash + docker-compose up --build + ``` + +6. Visit + 1. [http://localhost:3000](http://localhost:3000) - (Frontend) + 2. [http://localhost:8000](http://localhost:8000) - (Backend) \ No newline at end of file