Skip to content

Commit

Permalink
update CONTRIBUTING section
Browse files Browse the repository at this point in the history
  • Loading branch information
leandrocp committed Oct 11, 2023
1 parent 1d8d2fd commit a4e35d1
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 31 deletions.
32 changes: 1 addition & 31 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# How to contribute
# How to Contribute

## Issue Tags

Expand Down Expand Up @@ -45,33 +45,3 @@ get accepted:

If your pull-request addresses an issue then please add the corresponding
issue's number to the description of your pull-request.

# How to work with this project locally

## Installation

First clone this repository:

```sh
git clone [email protected]:BeaconCMS/beacon.git
```

Call setup to install deps:

```sh
mix setup
```

## Running tests

```sh
mix test
```

## Running a local app

```sh
iex -S mix dev
```

Check out https://github.com/BeaconCMS/beacon/blob/main/dev.exs and visit http://localhost:4001/dev/home
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@ Main components:
- Admin - LiveView UI to manage layouts, pages, and all other resources. See https://github.com/BeaconCMS/beacon_live_admin
- Page Builder - An easy to use, drag & drop UI for building pages, targeted to non-technical users. Not released yet, in the initial stages of development.

## Contributing

Check out the [CONTRIBUTING.md](https://github.com/BeaconCMS/beacon/blob/main/CONTRIBUTING.md) doc for overall guidelines to contribute to this project,
then follow the [Local Developments](https://github.com/BeaconCMS/beacon#local-development) steps to run a local project, or watch the video below to understand more
about Beacon internals:

<a href="https://www.youtube.com/watch?v=5jk0fIJOFuc">
<img src="https://raw.githubusercontent.com/BeaconCMS/beacon/main/assets/images/youtube_card.png" width="512" alt="YouTube card - ElixirConf 2023 - Leandro Pereira - Beacon: The next generation of CMS in Phoenix LiveView">
</a>

## Local Development

The file `dev.exs` is a self-contained Phoenix application running Beacon with sample data and code reloading enabled. Follow these steps to get a site up and running:
Expand Down
Binary file added assets/images/youtube_card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a4e35d1

Please sign in to comment.