PixelShare is a simple and easy-to-use amalgamated art project inspired by Jordan Fred. Users can access the quilt without login and can add their own pixel art to it. The application is built on the React framework, styled with Sass. The API uses a NodeJS back end with Express and MongoDB.
First ensure that you have Node and Git installed by entering:
$ brew update
$ brew install node
$ brew install git
Then, navigate into the directory where you want to clone the repository and enter:
$ git clone https://www.github.com/derekkramer/pixelshare.git
Proper development operation requires the PixelShare API and MongoDB. Follow the installation instructions for the PixelShare API, then ensure you have MongoDB running in another terminal window:
$ mongod
...and the API server running by navigating into the API repository and running:
$ npm start
Navigate back into the front end repository directory you cloned earlier and install dependencies:
$ npm install
Then, with the API server running on localhost:3001, start the front end server:
$ npm start
Your PixelShare development front end should be available at localhost:3000
To edit the styling, while in the front end directory, enter:
$ gulp
Then only edit the .scss files in the src/scss/ directory
The MIT License (MIT)
Copyright © 2017 Derek Kramer
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.