mirror of
https://github.com/usememos/memos.git
synced 2025-06-05 22:09:59 +02:00
chore: update docs
This commit is contained in:
47
README.md
47
README.md
@@ -36,53 +36,14 @@ Memos should be running at [http://localhost:5230](http://localhost:5230). If th
|
|||||||
|
|
||||||
### Docker Compose
|
### Docker Compose
|
||||||
|
|
||||||
See [the example `docker-compose.yaml`](./docker-compose.yaml) file.
|
See more in the example [`docker-compose.yaml`](./docker-compose.yaml) file.
|
||||||
|
|
||||||
## Development
|
## Contributing
|
||||||
|
|
||||||
Memos is built with a curated tech stack. It is optimized for developer experience and is very easy to start working on the code:
|
|
||||||
|
|
||||||
1. It has no external dependency.
|
|
||||||
2. It requires zero config.
|
|
||||||
3. 1 command to start backend and 1 command to start frontend, both with live reload support.
|
|
||||||
|
|
||||||
### Tech Stack
|
|
||||||
|
|
||||||
<img alt="tech stack" src="https://raw.githubusercontent.com/usememos/memos/main/resources/tech-stack.png" width="360" />
|
|
||||||
|
|
||||||
### Prerequisites
|
|
||||||
|
|
||||||
- [Go](https://golang.org/doc/install)
|
|
||||||
- [Air](https://github.com/cosmtrek/air#installation) for backend live reload
|
|
||||||
- [Node.js](https://nodejs.org/)
|
|
||||||
- [yarn](https://yarnpkg.com/getting-started/install)
|
|
||||||
|
|
||||||
### Steps
|
|
||||||
|
|
||||||
1. pull source code
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/usememos/memos
|
|
||||||
```
|
|
||||||
|
|
||||||
2. start backend using air(with live reload)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
air -c scripts/.air.toml
|
|
||||||
```
|
|
||||||
|
|
||||||
3. start frontend dev server
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd web && yarn && yarn dev
|
|
||||||
```
|
|
||||||
|
|
||||||
Memos should now be running at [http://localhost:3000](http://localhost:3000) and change either frontend or backend code would trigger live reload.
|
|
||||||
|
|
||||||
### Contributing
|
|
||||||
|
|
||||||
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. 🥰
|
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. 🥰
|
||||||
|
|
||||||
|
Gets more about [development guide](https://github.com/usememos/memos/tree/main/docs/development.md).
|
||||||
|
|
||||||
## Star history
|
## Star history
|
||||||
|
|
||||||
[](https://star-history.com/#usememos/memos&Date)
|
[](https://star-history.com/#usememos/memos&Date)
|
||||||
|
40
docs/development.md
Normal file
40
docs/development.md
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
# Development
|
||||||
|
|
||||||
|
Memos is built with a curated tech stack. It is optimized for developer experience and is very easy to start working on the code:
|
||||||
|
|
||||||
|
1. It has no external dependency.
|
||||||
|
2. It requires zero config.
|
||||||
|
3. 1 command to start backend and 1 command to start frontend, both with live reload support.
|
||||||
|
|
||||||
|
## Tech Stack
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- [Go](https://golang.org/doc/install)
|
||||||
|
- [Air](https://github.com/cosmtrek/air#installation) for backend live reload
|
||||||
|
- [Node.js](https://nodejs.org/)
|
||||||
|
- [yarn](https://yarnpkg.com/getting-started/install)
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
1. pull source code
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/usememos/memos
|
||||||
|
```
|
||||||
|
|
||||||
|
2. start backend using air(with live reload)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
air -c scripts/.air.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
3. start frontend dev server
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd web && yarn && yarn dev
|
||||||
|
```
|
||||||
|
|
||||||
|
Memos should now be running at [http://localhost:3000](http://localhost:3000) and change either frontend or backend code would trigger live reload.
|
Reference in New Issue
Block a user