This project provides a few cool tools as a foundation, so it'd be worthwhile to check them out before getting started:
- Babel for nextgen JavaScript features
- ESLint for help with JavaScript code errors and style
- Flow for type-checking your JavaScript code
- Sass + Autoprefixer for enhancing CSS with some nice features
- Stylelint for help with CSS code errors and style
- Parcel for building and running the app
Getting the app installed isn't too scary! Just a few simple steps and you'll be all set:
- Fork the sample repo in GitHub so you have your own copy of the app
- Open a terminal/console and navigate to whatever folder you want the project to be in
- Clone your fork with
git clone [email protected]:YOUR_GITHUB_USERNAME/email-client-practice-app.git
- Navigate into the downloaded folder with
cd email-client-practice-app
- Install the dependencies:
Once all the setup is complete, you can actually start using and developing the app:
- Start the app's development server using
yarn start
, then go tohttp://localhost:1234
in your browser to see it (stop the server with theCtrl
+C
keys) - If you want to run the linters on your code, use
yarn lint
- To just lint your JavaScript code,
yarn lint:js
- To just lint your CSS/Sass code,
yarn lint:sass
- To just lint your JavaScript code,
- If you want to run Flow's type checks, use
yarn flow
This project is intended to be yours, so at this point you can go wild creating the email client you've always wanted. Just a couple of last notes:
- Initial source code files can be found in the
src
folder - The final app code outputs to the
dist
folder
That's it; dream big!