Skip to content

Latest commit

 

History

History
62 lines (48 loc) · 2.88 KB

readme.md

File metadata and controls

62 lines (48 loc) · 2.88 KB
Raw

Client UI Email 📧

Simple personal email manager that allows you to: see inbox and sent an email.

This is an Universal React Application. Consists in a very simple Client UI Email built with Node.js and Express for server and the API REST, and in the other side, React for UI solution with Redux for state management. Also uses other modern libraries such as Material-UI, PostCSS, Babel 7 and Webpack 4.

Requirements

  • Mac OS X, Windows, or Linux
  • Node.js v9.0 or newer
  • Text editor or IDE pre-configured with React/JSX/ESlint/Stylelint

Directory Layout

Before you start, take a moment to see how the project structure looks like:

.
├── /node_modules/                  # 3rd-party libraries and utilities
├── /src/                           # Source code
│   ├── /actions/                   # Redux actions creators divided by feature
│   ├── /client/                    # Client entry point and specified 
│   ├── /components/                # Components separated by Helpers / UI / Views
│   ├── /core/                      # Other core frameworks
│   ├── /reducers/                  # Reducers for trigger that updates the Redux Store
│   ├── /server/                    # Node.js with Express server applica tion and API REST
│   ├── /store/                     # Contains a helper to build Redux store
│   └── /utils/                     # JS Utils
├── .babelrc                        # Plugins and extensions for Babel
├── .editorconfig                   # Configuration for your IDE used
├── .eslintrc.json                  # ESLint configuration and rules for code consistency!
├── .env.example                    # Environment variables
└── package.json                    # The list of 3rd party libraries and utilities

Getting Started

  1. Clone the repo and install all dependencies
$ git clone git@github.com:adrivelasco/dummy-client-email.git
$ cd dummy-client-email
$ npm install -g webpack
$ npm install

  1. Copy the .env.example content file to .env and configure it. (Otherwise, server uses default config)

  2. Build and start server

  • Production mode
$ npm run prod
  • Development mode (run tasks in parallel)
$ npm run build:watch
$ npm run start: watch

Made with Adrián Velasco (@adrivelasco)