Skip to content

Commit

Permalink
Initial version, pre-release.
Browse files Browse the repository at this point in the history
  • Loading branch information
margni-stephen committed Mar 11, 2020
1 parent 6cade76 commit 6030b4c
Show file tree
Hide file tree
Showing 59 changed files with 4,055 additions and 191 deletions.
8 changes: 8 additions & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
REACT_APP_VERSION=$npm_package_version
REACT_APP_FIREBASE_KEY="AIzaSyDdkG6cSAFHGRzOawFsyg83doDozxRt2pc"
REACT_APP_FIREBASE_AUTH_DOMAIN="margni-note.firebaseapp.com"
REACT_APP_FIREBASE_DATABASE_URL="https://margni-note.firebaseio.com"
REACT_APP_FIREBASE_PROJECT_ID="margni-note"
REACT_APP_FIREBASE_STORAGE_BUCKET="margni-note.appspot.com"
REACT_APP_FIREBASE_MESSAGING_SENDER_ID=1014018088230
REACT_APP_FIREBASE_APP_ID: "1:1014018088230:web:67f4ad959540df2d6235e7"
Empty file added .env.development
Empty file.
5 changes: 5 additions & 0 deletions .firebaserc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"projects": {
"default": "margni-note"
}
}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
/node_modules
/.pnp
.pnp.js
/.firebase
/.idea

# testing
/coverage
Expand Down
88 changes: 48 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,76 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# mNote

## Available Scripts
[note.margni.com](https://note.margni.com)

In the project directory, you can run:
mNote is an extremely minimal note taking web app.

### `npm start`

Runs the app in the development mode.<br />
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.<br />
You will also see any lint errors in the console.
## About

### `npm test`
This is built as a technical demonstration for a bare-bones React+Firebase PWA.

Launches the test runner in the interactive watch mode.<br />
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
***Please note this is still a work in progress.***

### `npm run build`
### Appearance

Builds the app for production to the `build` folder.<br />
It correctly bundles React in production mode and optimizes the build for the best performance.
Designed to be extremely minimal. Design and layout component architecture inspired by Material Design.

The build is minified and the filenames include the hashes.<br />
Your app is ready to be deployed!
CSS uses native variables rather than SASS and also uses BEM class naming conventions.

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### Technical

### `npm run eject`
Does not use Flux style pattern but does use Context for simplicity's sake. This approach may not be appropriate in a real-world application.

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
## To Do

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
### Features

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
- Use history api or routing. Essentially just respond to the back button.
- Other login options?
- Service worker should produce dialogue when reload available.
- Delete confirmation dialogue.
- Long press on list.
- Offline Indicator.
- Catch and log firestore and auth errors.
- Install prompt/enhanced process.
- FAB should slide off screen on scroll down and back on on scroll up.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
### Bugs

## Learn More
- On iOS new note's textarea is not focused (works as expected when editing existing).
- Auth seems unstable, could be something to do with react lifecycle?
- General instability on mobile, may be resolved now.

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
### Code Quality

To learn React, check out the [React documentation](https://reactjs.org/).
- Improve firebase encapsulation.
- Components, separation of concerns and context usage is all a mess.
- Write Tests!
- CI pipeline.
- Tighten linting.

### Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
## Available Scripts

### Analyzing the Bundle Size
In the project directory, you can run:

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
### `npm start`

### Making a Progressive Web App
Runs the app in the development mode.<br />
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
The page will reload if you make edits.<br />
You will also see any lint errors in the console.

### Advanced Configuration
### `npm test`

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
Launches the test runner in the interactive watch mode.<br />
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### Deployment
### `npm run build`

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
Builds the app for production to the `build` folder.<br />
It correctly bundles React in production mode and optimizes the build for the best performance.

### `npm run build` fails to minify
The build is minified and the filenames include the hashes.<br />
Your app is ready to be deployed!

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
52 changes: 52 additions & 0 deletions assets/icon-arrow-left.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
67 changes: 67 additions & 0 deletions assets/icon-bin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 6030b4c

Please sign in to comment.