thunderstrike/plane
thunderstrike/plane
2
0
Fork 0
forked from github/plane
Code Pull Requests Activity

docs: added self hosting docs and updated Readme

Browse Source
This commit is contained in:
pablohashescobar 2023-01-11 02:02:31 +05:30 committed by vamsi
parent 77bbd3feee
commit 1e3af2e9e2
3 changed files with 107 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -2,41 +2,50 @@
<p align="center">
<a href="https://plane.so">
<img src="https://ik.imagekit.io/w2okwbtu2/plane-logo_0m83xue7R.png?ik-sdk-version=javascript-1.4.3&updatedAt=1668862717084" alt="Plane Logo" width="350">
<img src="https://res.cloudinary.com/dgxawjvpo/image/upload/v1673379660/Plane/plane-logo_0m83xue7R_f0v9r9.png" alt="Plane Logo" width="350">
</a>
</p>
<br />
Plane helps you track your issues, epics, and product roadmaps. Take off and experience the world of project management like never before.
<br /><br />
<p align="center">
<a href="https://discord.com/invite/29tPNhaV">
<img alt="Discord" src="https://img.shields.io/discord/1031547764020084846?color=5865F2&label=Discord&style=for-the-badge" />
</a>
<img alt="Discord" src="https://img.shields.io/github/commit-activity/m/makeplane/plane?style=for-the-badge" />
</p>
# Getting Started
<br />
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.
<br /> <br />
> 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.

2
apps/docs/src/components/Header.jsx
View File

@ -70,7 +70,7 @@ export const Header = forwardRef(function Header({ className }, ref) {
<ul role="list" className="flex items-center gap-8">
<TopLevelNavItem href="https://plane.so/">Plane Cloud</TopLevelNavItem>
<TopLevelNavItem href="https://github.com/makeplane/plane">GitHub</TopLevelNavItem>
<TopLevelNavItem href="https://discord.com/invite/A92xrEGCge">Support</TopLevelNavItem>
<TopLevelNavItem href="https://discord.com/invite/A92xrEGCge">Discord | Support</TopLevelNavItem>
</ul>
</nav>
<div className="hidden md:block md:h-5 md:w-px md:bg-zinc-900/10 md:dark:bg-white/15" />

81
apps/docs/src/pages/self-hosting.mdx
View File

@ -1,3 +1,82 @@
# Self Hosting Plane
Coming soon.
import { Heading } from '@/components/Heading'
<Note>
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).
</Note>
<Heading level={2} id="project-requirements">
Requirements
</Heading>
1. Git
2. Docker
3. Docker-compose
<Heading level={2} id="project-requirements">
Project set-up
</Heading>
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)