Web Purple Web Site

How to start the project?

[configure database](#database)
npm install
npm run start

Database

MongoDB is used in this app (hosted on mLab).

To change the connection configuration, see src/server/conf/db.js

For development purposes, you can either use the following db:

const connectionUrl = 'mongodb://admin:123123@ds064718.mlab.com:64718/webpurple';

or set up your own db (500MB for free in mLab)

Facebook

In-app authorization can be done via Facebook. Facebook app credentials should be passed to src/server/conf/passport.js

For development purposes, you can use the following credentials:

fb: {
    clientID: '1208431049220025',
    clientSecret: '39bf839eeb8805fd32f77dd70fac3604',
    ...

Flow

flow-typed install
npm run flow

If you encounter any errors with the external library, you can create a stub with:

flow-typed create-stub my-package

You probably want to upgrade your editor/IDE with a Flow plugin to see errors reported by Flow in the editor.

How to contribute?

We are open to, and grateful for, any contributions made by the community.

You can find a list of issues you can work on here. Feel free to create new ones.

In general, the contribution workflow looks like this:

1. Fork the repo.
2. Create a new feature branch based off the master branch.
3. Make sure all tests pass (npm run test) and there are no linting errors (npm run lint).
4. Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

You can read more about contributing here.

Commit messages

Feel free to use emoji in your commit messages 😧 (More about it here).

Useful links

redux