Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Ezy committed Apr 1, 2020
1 parent 381d768 commit 5142830
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Spec app for jsonplaceholder.typicode.com

This is a ReactJS app using the blog api from typicode, built to show my approach to building. It includes the following methodolgy:
This is a ReactJS app using the blog api from typicode, built to show my approach to react dev. It includes the following methodolgy:

- Functional programming as per the current direction of React
- Tests setup with Jest and Enzyme
Expand All @@ -13,11 +13,11 @@ The entire app was built in 2 coding sessions for a total time of around 2.5 hou

## Setup methodology

Created with the standard Create React App - [see a shell script for doing similar in one hit here](https://gist.github.com/ezy/107c74c014251f0c8f2c2b0bea460d58)
Created with the standard Create React App - [see a shell script for doing similar with typescript in one hit here](https://gist.github.com/ezy/107c74c014251f0c8f2c2b0bea460d58)

## Available Scripts

The standard create react scripts are availavle in `package.json` for doing the basics.
The standard create react scripts are availavle in `package.json` for doing all the usual basics.

There are added scripts for the following:

Expand All @@ -27,23 +27,24 @@ There are added scripts for the following:

## Linting

Linting is setup to ensure code quality and consistency.
Linting is setup to ensure code quality and consistency using eslint, prettier and airbnb style guide.

## Components

All components reside in `src/components`.

## Helpers

All components reside in `src/helpers`. If there was a requirement for any services (eg. extracting fetch into a single http request service) they would be located in `src/services`.
All helpers reside in `src/helpers`. If there was a requirement for any services (eg. extracting fetch into a single http request service) they would be located in `src/services`.

## Tests

All tests reside in `src/__tests__`. They're an example rather than being exhaustive in the interest of saving time on spec work.
All tests reside in `src/__tests__`. They're an example rather than being exhaustive to show a few different scenarios.

## Things I would do for prod

- Use typescript (.tsx, .ts)
- Use `docker-compose` for running any backend and db
- Implement a CI/CD solution
- Extract fetch into an http service for GET, PUT, POST, PATCH, DELETE
- Use [EmberJS](https://emberjs.com/) (jokes, although it is totally the best solution for big orgs building PWAs)
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5142830

Please sign in to comment.