https://github.com/andreidmt/bucharest-1871
A map of Bucharest in 1871
https://github.com/andreidmt/bucharest-1871
Last synced: 3 months ago
JSON representation
A map of Bucharest in 1871
- Host: GitHub
- URL: https://github.com/andreidmt/bucharest-1871
- Owner: andreidmt
- License: bsd-3-clause
- Created: 2018-11-26T08:55:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-12-19T08:24:33.000Z (over 6 years ago)
- Last Synced: 2025-01-01T10:42:20.412Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 37.6 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Bucharest 1871
> A map of Bucharest in 1871
---
- [About](#about)
- [Install](#install)
- [Use](#use)
- [Develop](#develop)
- [Tech dept](#tech-dept)
- [Changelog](#changelog)
- [0.2.1 - 11 December 2018](#021---11-december-2018)
- [Change](#change)
## About
- Build: [Parcel](http://parceljs.org/), [Babel 7](https://babeljs.io/)
- App framework: [React](http://reactjs.org/), [Redux](https://redux.js.org/), [React Router 4](https://reacttraining.com/react-router/web/guides/quick-start), [@asd14/redux-all-is-list](https://github.com/asd14/redux-all-is-list)
- CSS: [PostCSS](https://postcss.org/) with css modules, [Sanitize.css](https://github.com/csstools/sanitize.css) & [FontAwesome 5](https://fontawesome.com/changelog/latest)
- Lint/Types: [ESLint](https://eslint.org/) with [@asd14/eslint-config](https://github.com/asd14/eslint-config), [FlowType](https://flow.org/)
- Tests: [Tape](https://github.com/substack/tape/) and [react-test-renderer](https://reactjs.org/docs/test-renderer.html)
## Install
```bash
git clone [email protected]:andreidcm/bucharest-1871.git && \
cd bucharest-1871 && \
npm run setup
```
## Use
1. _Install packages and flow-typed definitions_
`npm run setup`
1. _Setup environment variables_
Copy and rename `.env-template` -> `.env`
1. _Start API mock server_: `localhost:3000` - CRUD endpoints for POI model (uses `mock-db.json` as persistent storage)
`npm run start:mock`
1. _Start Parcel development server_: `localhost:1234`
`npm start`
## Develop
```bash
# run tests (any `*.test.js`) once
npm test
# watch `src` folder for changes and run test automatically
npm run tdd
```
## Tech dept
- [x] Dont load router in UIGrid component
- [ ] POIListPage and POIItemPage should have separate state list
## Changelog
History of all changes in [CHANGELOG.md](CHANGELOG.md)
### 0.2.1 - 11 December 2018
### Change
- Fix all flow errors