outlor
outlor copied to clipboard
Outlor
What is Outlor
Outlor does cool things with CSS and DOM elements with your url.
Features
- Quickly grab colours code used in the site.
- Helpful for designers who are quickly prototyping and end up using different shades of the same base colour.
Getting started
# Clone the project
git clone https://github.com/martinbjeldbak/outlor.git
cd outlor
# Install dependencies
yarn
If you don't use Yarn you can just replace yarn
with npm
in the commands that follow.
Then you can begin development:
yarn run dev
This will launch a nodemon process for automatic server restarts when your code changes.
Testing
Testing is powered by Jest. This project also uses supertest for demonstrating a simple routing smoke test suite. Feel free to remove supertest entirely if you don't wish to use it.
Start the test runner in watch mode with:
yarn test
You can also generate coverage with:
yarn test -- --coverage
(the extra double hyphen --
is necessary).
Linting
Linting is set up using ESLint. It uses ESLint's default eslint:recommended rules. Feel free to use your own rules and/or extend another popular linting config (e.g. airbnb's or standard).
Begin linting in watch mode with:
yarn run lint
Environmental variables in development
The project uses dotenv for setting environmental variables during development. Simply copy .env.example
, rename it to .env
and add your env vars as you see fit.
It is strongly recommended never to check in your .env file to version control. It should only include environment-specific values such as database passwords or API keys used in development. Your production env variables should be different and be set differently depending on your hosting solution. dotenv
is only for development.
Deployment
Deployment is specific to hosting platform/provider but generally:
yarn run build
will compile your src into /dist
, and
yarn start
will run build
(via the prestart
hook) and start the compiled application from the /dist
folder.
The last command is generally what most hosting providers use to start your application when deployed, so it should take care of everything.
You can find small guides for Heroku, App Engine and AWS in the deployment document.
License
MIT License. See the LICENSE file.