Skip to content

Latest commit

 

History

History
85 lines (59 loc) · 2.75 KB

README.md

File metadata and controls

85 lines (59 loc) · 2.75 KB
Raw

Simple react + mobx demo covering login with cookie storage, registration and navigation and a few more pages

How to install

  1. Rename .env_example to .env
  2. yarn
  3. yarn start
  4. Set up your api 
  5. Edit .env and all urls called on src/utils/api.js to match your settings
  6. Replace where api.fakeLogin and api.fakeFetch are called with api.login() and api.fetch()

Folder Structure

my-app/
  README.md
  node_modules/
  package.json
  public/
    index.html
    favicon.ico
  src/
    containers/ - layouts
    pages/
    partials/
    utils/
      store.js
      api.js - edit this to fit your api 
      database.js - for the fake api calls
      cookies.js - easy api for accessing cookies
    index.js - entry point

For the project to build, these files must exist with exact filenames:

  • public/index.html is the page template;
  • src/index.js is the JavaScript entry point.

You can delete or rename the other files.

You may create subdirectories inside src. For faster rebuilds, only files inside src are processed by Webpack.
You need to put any JS and CSS files inside src, or Webpack won’t see them.

Only files inside public can be used from public/index.html.
Read instructions below for using assets from JavaScript and HTML.

You can, however, create more top-level directories.
They will not be included in the production build so you can use them for things like documentation.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.

yarn run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

yarn run eject

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

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.

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.

Bootstrapped using Create React App.