Skip to content

opencollective/opencollective-emails

Repository files navigation

Open Collective Emails

Foreword

If you see a step below that could be improved (or is outdated), please update the instructions. We rarely go through this process ourselves, so your fresh pair of eyes and your recent experience with it, makes you the best candidate to improve them for other users. Thank you!

Development

Prerequisite

  1. Make sure you have Node.js version >= 11.
  • We recommend using nvm: nvm install.
  1. Install lerna as a global package
  • npm install -g lerna

Install

We recommend cloning the repository in a folder dedicated to opencollective projects.

git clone git@github.com:opencollective/opencollective-emails.git opencollective/emails
cd opencollective/emails
lerna bootstrap
lerna link

Start

Compile the client with:

npm run watch

In a separate process, start the server with:

npm run dev

Contributing

Code style? Commit convention? Please check our Contributing guidelines.

TL;DR: we use Prettier and ESLint, we do like great commit messages and clean Git history.

Release

You will need write access to the opencollective organization on npm. Check who you are with npm whoami and npm login if necessary.

Make sure your environment is clean and ready for publish:

lerna clean -y
lerna bootstrap

Then run:

lerna publish

License

MIT