Skip to content

docs: add project structure section and document Bridge app #2946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0xEdmundo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add project structure section and document Bridge app #2946

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,38 @@ To start a development server on localhost, run `yarn workspace @app/<project> d

For example, to start the `web` app locally, you would run `yarn workspace @app/web dev`.

## Project Structure

```
.
├── apps/
│ ├── bridge/ # Base Bridge application
│ └── web/ # Main base.org website
├── libs/
│ └── base-ui/ # Shared UI component library
└── tools/ # Build and development tools
```

## Projects

There are three projects which can be run individually.
There are two applications and a shared library in this monorepo.

### Web

The main base.org website.

```
yarn workspace @app/web dev
```

### Bridge

The Base Bridge application.

```
yarn workspace @app/bridge dev
```

## Contributing

We welcome contributions to Base! For guidelines on how to contribute please refer to [CONTRIBUTING.md](CONTRIBUTING.md).
Expand Down