Skip to content
Snippets Groups Projects
Unverified Commit f8ce4e11 authored by ArtOfCode's avatar ArtOfCode Committed by GitHub
Browse files

Merge pull request #139 from galegosimpatico/doc-20200824

parents bbc932d1 a55181b1
Branches
No related tags found
No related merge requests found
......@@ -36,7 +36,9 @@ If you already have Node.JS installed, you can skip this step. If not, [download
If you haven't already got it, [download and install Redis](https://redis.io/download).
### Install Imagemagick
If you haven't already installed Imagemagick, you'll need to [install it for your system](https://imagemagick.org/script/download.php)
If you haven't already installed Imagemagick, you'll need to [install it for
your system][0].
### Download QPixel
Clone the repository and `cd` into the directory:
......@@ -78,12 +80,16 @@ Run the server!
rails s
You'll need to create a Community record before the server will display any content. In a console, run:
You'll need to create a Community record before the server will display any
content. In a Rails console (`rails c`), run:
```ruby
Community.create(name: 'Dev Community', host: 'localhost:3000')
```
If it keeps not showing content, `Rails.cache.clear` from your Rails console as
necessary.
You can create the first user account in the application, which should be running at http://localhost:3000/. To upgrade the user account
to an admin account, run `rails c` for a console, followed by:
......@@ -92,8 +98,11 @@ User.last.update(confirmed_at: DateTime.now, is_global_admin: true)
```
## License
[AGPL licensed](https://github.com/codidact/qpixel/blob/master/LICENSE)
[AGPL licensed](https://github.com/codidact/qpixel/blob/master/LICENSE).
## Contributing
Contributions are welcome - please read the [CONTRIBUTING](https://github.com/codidact/qpixel/blob/develop/CONTRIBUTING.md) document
before you start and look at the [TODO list](https://github.com/codidact/qpixel/wiki/TODO-list) for things to do.
[0]: https://imagemagick.org/script/download.php
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment