Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lsst-epo/empty-investigation
Very Basic Starter projjie for Investigation exploration
https://github.com/lsst-epo/empty-investigation
Last synced: 4 days ago
JSON representation
Very Basic Starter projjie for Investigation exploration
- Host: GitHub
- URL: https://github.com/lsst-epo/empty-investigation
- Owner: lsst-epo
- License: mit
- Created: 2019-09-17T00:45:40.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-23T10:42:32.000Z (over 2 years ago)
- Last Synced: 2023-02-27T08:46:39.979Z (over 1 year ago)
- Language: JavaScript
- Size: 1.6 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## Investigation Starter
Dev envirnoment inspired by [homegrown Webpack-React starter project](https://github.com/lsst-epo/webpack-react-boilerplate).
### Table of contents
[Project structure](#project-structure)
[Installation](#installation)
[Deploying](#deploying)
[Configuration](#configuration)
[Development Dependencies](#development-dependencies)
[General Dependencies](#general-dependencies)
### Project structure
```
build/
src/
|- index.jsx _______________________________ # application entry
|- App.jsx _________________________________ # application init
| |- components/___________________________ # react components
| |- assets/
| |- images/_____________________________ # see SiteHeader for image incorporation in .jsx file
| |- static-data/_________________________# see Questions.jsx for HTTP Request for data example
| |- stylesheets/
| |- STACSS/ _________________________ # global Structure, Typography, and Appearance styles
| |- components/ _____________________ # should generally correspond to React Compoents
```
### Installation
1- Clone the repo: `git clone https://github.com/lsst-epo/empty-investigation.git`
2- Install npm packages: `yarn`
### Development
1- Start dev server: `yarn start` (or `yarn start-dash` to run webpack-dev-server with [webpack dashboard](https://github.com/FormidableLabs/webpack-dashboard))
2- Unit testing will watch all your changes in the test files as well as create coverage folder: `yarn test`
3- Build and bundle assets for Production: `yarn build`
4- Build and bundle assets for Staging: `yarn netflify-deploy`
### Deploying
#### Production:
Deploy to Production (Github Pages) via [gh-pages module](https://github.com/tschaub/gh-pages): `yarn deploy`
#### Staging:
Push changes to master, or create pull request to trigger a build/deploy to [Continuous Deployment to Netlify](https://www.netlify.com/docs/continuous-deployment/)
### Configuration
```
Webpack
|- webpack.config.js _______________________ # merging common and environment specific configs
|- paths.js ________________________________ # Webpack paths needed
|- webpack.common.js _______________________ # common Webpack config
|- webpack.dev.js __________________________ # development config
|- webpack.prod.js _________________________ # production config
BrowserList
|- .browserlistrc __________________________ # BrowserList config
Babel
|- babel.config.js _________________________ # Babel config
PostCSS
|- postcss.config.js _______________________ # PostCSS config
linting
|- .eslintrc _______________________________ # ESlint rules to apply
|- .eslintignore ___________________________ # what not to ESlint
|- .prettierrc _____________________________ # Prettier config (consumed by eslint)
|- .stylelintrc ____________________________ # Stylelint config
testing
|- setupTests.js ___________________________ # Enzyme config
IDE
|- .editorconfig ___________________________ # coding styles definitions
git
|- .gitignore ______________________________ # what not to track
|- .PULL_REQUEST_TEMPLATE.md _______________ # if you want to provide a PR template
```
#### Development Dependencies
- [Webpack 4](https://github.com/webpack/webpack)
- [Babel 7](https://github.com/babel/babel) [ transforming JSX, ES6, ES7, and ES8 ]
- [Jest](https://github.com/facebook/jest) [ Unit test]
- [Enzyme](http://airbnb.io/enzyme/) for UI testing.
- [Eslint](https://github.com/eslint/eslint/) with airbnb config
- [Stylelint](https://stylelint.io/) for linting SCSS/CSS
- [Prettier](https://github.com/prettier/prettier) [ JS formatter ]
- [EditorConfig](https://editorconfig.org/) [ Code Style definitions ]
- [STACSS](https://github.com/castiron/STACSS) [ SCSS architecture ]
- [Style Loader](https://github.com/webpack-contrib/style-loader) & [CSS Loader](https://github.com/webpack-contrib/css-loader) & [SASS-loader](https://github.com/webpack-contrib/sass-loader) & [PostCSS](https://github.com/postcss/postcss) with [Autoprefixer](https://github.com/postcss/autoprefixer)
- [Browserslist](https://github.com/browserslist/browserslist) [ Share target browsers between different front-end tools, like Autoprefixer, Stylelint and babel-preset-env ]
- [React hot loader](https://github.com/gaearon/react-hot-loader)
- [Webpack dev server](https://github.com/webpack/webpack-dev-server)
- [gh-pages](https://github.com/tschaub/gh-pages) [Gihub Pages deployment]
#### General Dependencies
- [React](https://github.com/facebook/react) `16.8`
- [prop-types](https://github.com/facebook/prop-types) `16.8`
- [React Router](https://github.com/ReactTraining/react-router) `5.0.1`
- [Reactn](https://github.com/CharlesStover/reactn) `2.1.4`
- [Axios](https://github.com/axios/axios) `0.19.0`
- [Local Storage](https://github.com/bevacqua/local-storage) `2.0.0`
- [Lodash](https://github.com/lodash/lodash)
- [D3](https://github.com/d3/d3) `5.9.2`