Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
sustained committed Feb 26, 2019
1 parent 0fc5c3a commit c3bccb3
Showing 1 changed file with 52 additions and 18 deletions.
70 changes: 52 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,70 @@
# Cello
# laravel-forum

- [Project Setup](#project-setup)
- [Project Information](#project-information)

## Project setup

If you'd like to check this out locally, then follow the instructions below.

### Clone

First clone the repository, of course:

```bash
git clone git@github.com:sustained/cello.git
cd cello
```
npm install
```

### Compiles and hot-reloads for development
### Install

Then install the dependencies.

```bash
npm i
```

### Run

Then start 'er up!

```bash
npm run serve
npm run api
```

### Compiles and minifies for production
---

```
npm run build
```
## Project Information

### Run your tests
### What is this?

```
npm run test
```
This is a [Trello](https://www.trello.com/) clone (a kanban board).

### Lints and fixes files
I'm primarily using it to learn more about Vue, Vuex and Vue-Router.

```
npm run lint
```
### Why a Trello clone?

I use Trello a lot and I quite like it, it's pretty great software but there's definitely a few things I wouldn't mind trying to do differently!

So, why not?

### How will this be different?

See the [Trello board(https://trello.com/b/yj3Lb4Gu/project-cello) (ironic, I know) if you're curious about my ideas.

### When will it be done?

Soon™?

### Where is it hosted?

It isn't, yet. But if there's demand, maybe I'll do that.

### Customize configuration
### Who are you?

See [Configuration Reference](https://cli.vuejs.org/config/).
- I spend arguably far too much time on Discord (sustained#2329).
- I have a [website](https://www.sustained.name/) but it doesn't do much yet.
- I don't really _get_ [Twitter](https://twitter.com/@susDissonance) but it exists.
- [Medium](https://medium.com/@sustained) is a thing, also.
- Here on [Github](https://github.com/sustained) you can('t) find my private repos for abandoned projects!

0 comments on commit c3bccb3

Please sign in to comment.