mirror of
https://github.com/toeverything/AFFiNE.git
synced 2024-12-24 04:52:14 +03:00
Merge pull request #53 from toeverything/docs/readme-link-to-gitbook
Docs: readme link to gitbook and Table of contents
This commit is contained in:
commit
7690511562
84
README.md
84
README.md
@ -43,6 +43,24 @@ See https://github.com/all-contributors/all-contributors/issues/361#issuecomment
|
||||
|
||||
![952cd7a5-70fe-48ab-b74f-23981d94d2c5](https://user-images.githubusercontent.com/79301703/182365526-df074c64-cee4-45f6-b8e0-b912f17332c6.gif)
|
||||
|
||||
# Table of contents
|
||||
|
||||
- [Stay Up-to-Date](#stay-up-to-date)
|
||||
- [Table of contents](#table-of-contents)
|
||||
- [Shape your page](#shape-your-page)
|
||||
- [Plan your task](#plan-your-task)
|
||||
- [Sort your knowledge](#sort-your-knowledge)
|
||||
- [Create your story](#create-your-story)
|
||||
- [Getting Started with development](#getting-started-with-development)
|
||||
- [Roadmap](#roadmap)
|
||||
- [Releases](#releases)
|
||||
- [Feature requests](#feature-requests)
|
||||
- [FAQ](#faq)
|
||||
- [The Philosophy of AFFiNE](#the-philosophy-of-affine)
|
||||
- [Community](#community)
|
||||
- [Contributors](#contributors)
|
||||
- [License](#license)
|
||||
|
||||
## Shape your page
|
||||
|
||||
![546163d6-4c39-4128-ae7f-55d59bc3b76b](https://user-images.githubusercontent.com/79301703/182365611-b0ba3690-21c0-4d9b-bfbc-0bc15da05aeb.gif)
|
||||
@ -63,7 +81,7 @@ Affine is fully built with web technologies so that consistency and accessibilit
|
||||
|
||||
# Getting Started with development
|
||||
|
||||
Please view the [documentation](https://affine.gitbook.io/affine/) for OS specific development instructions
|
||||
Please view the [documentation](https://affine.gitbook.io/affine/) in Contribute-to-AFFiNE/Software-Contributions/Environment-setup.
|
||||
|
||||
# Roadmap
|
||||
|
||||
@ -119,71 +137,13 @@ We would also like to give thanks to open-source projects that make affine possi
|
||||
- React
|
||||
- Rust
|
||||
|
||||
# Installation
|
||||
|
||||
Please view the [documentation](https://affine.gitbook.io/affine/) for OS specific installation instructions.
|
||||
|
||||
```sh
|
||||
# Clone the repo
|
||||
git clone git@github.com:toeverything/AFFiNE.git
|
||||
```
|
||||
|
||||
Once cloned, switch to the master branch and navigate to the folder by typing `cd AFFiNE` and then running the following commands:
|
||||
|
||||
```sh
|
||||
# Install all project dependencies
|
||||
npm i -g pnpm
|
||||
pnpm i
|
||||
|
||||
# Start the project
|
||||
pnpm start
|
||||
open http://localhost:4200/
|
||||
```
|
||||
|
||||
This project uses pnpm for package management and is built based on nx. It is recommended to install the [nx console](https://marketplace.visualstudio.com/items?itemName=nrwl.angular-console) plugin to create dependencies
|
||||
|
||||
**If it is development, you can add environment variables in the project directory .env.local file**
|
||||
|
||||
```
|
||||
NODE_ENV=development
|
||||
```
|
||||
|
||||
## Scripts
|
||||
|
||||
1. Create react dependency library: `pnpm run add:library`
|
||||
2. Create react components: `pnpm run add:components`
|
||||
3. Create a data source: `pnpm run add:datasource`
|
||||
4. Unit testing: `pnpm test`
|
||||
5. Compile specific components
|
||||
- `pnpm build/test/lint `project name
|
||||
- Project name reference workspace.json
|
||||
6. Create react/node program: use nx console
|
||||
7. If you need to use the git cz function, please install it globally first commitizen `npm install -g commitizen conventional-changelog conventional-changelog-cli`
|
||||
|
||||
## Contributing
|
||||
|
||||
- Generic functional components (such as ui components) are placed in `libs/components/common`
|
||||
- components within common are not allowed to reference _components_ except utils and dependencies
|
||||
- Common components can reference each other
|
||||
- Business components are placed in `libs/components`
|
||||
- The data source component is placed in `libs/datasource` - api request code, schema, etc. belong to the data source
|
||||
Please see [CONTRIBUTING](/docs/CONTRIBUTING.md)
|
||||
|
||||
## Documentation
|
||||
|
||||
- [how-to-write-css-in-affine.md](/docs/how-to-write-css-in-affine.md)
|
||||
- [how-to-add-ui-component-in-affine.md](/docs/how-to-add-ui-component-in-affine.md)
|
||||
- [how-to-customize-rollup-config.md](docs/how-to-customize-rollup-config.md)
|
||||
- [how-to-auto-download-figma-assets-in-affine.md](docs/how-to-auto-download-figma-assets-in-affine.md)
|
||||
- [affine-icons-user-guide.md](docs/affine-icons-user-guide.md)
|
||||
|
||||
## Community
|
||||
# Community
|
||||
|
||||
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
|
||||
|
||||
[Discuss AFFiNE on GitHub](https://github.com/toeverything/AFFiNE/discussions)
|
||||
|
||||
## Contributors
|
||||
# Contributors
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
@ -211,7 +171,7 @@ For help, discussion about best practices, or any other conversation that would
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
## License
|
||||
# License
|
||||
|
||||
AFFiNE is distributed under the terms of MIT license.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user