SocialCake

SocialCake code for NEM hackathon

This project was bootstraped with React Firebase Starter by Kriasoft.

Tech Stack

Create React App for development and test infrastructure (see user guide)
Material UI to reduce development time by integrating Google's Material Design
Styled Components for component friendly CSS styles (docs)
Firebase for serverless architecture, authentication and free CDN hosting (docs)
Universal Router + history for declarative routing and client-side navigation

Directory Layout

├── node_modules/                  # 3rd-party libraries and utilities
├── public/                        # Static files such as favicon.ico etc.
├── src/                           # Application source code
│   ├── components/                # Shared React components
│   ├── routes/                    # Components for pages/screens + routing information
│   ├── auth.js                    # Authentication manager
│   ├── history.js                 # Client-side navigation manager
│   ├── index.js                   # <== Application entry point (main) <===
│   ├── registerServiceWorker.json # This list of application routes
│   ├── relay.js                   # Relay Modern client
│   ├── graphql.schema             # GraphQL schema obtained from a GraphQL API
│   └── theme.js                   # Overrides for Material UI default styles
├── package.json                   # The list of project dependencies + NPM scripts
└── setup.js                       # Customizations for create-react-app

Prerequisites

Node.js v8.9 or higher + Yarn v1.3 or higher (HINT: On Mac install them via Brew)
VS Code editor (preferred) + Project Snippets, EditorConfig, ESLint, Flow, Prettier, and Babel JavaScript plug-ins

Getting Started

Just clone the repo and start hacking:

$ git clone https://github.com/amrue/SocialCake.git MyApp
$ cd MyApp
$ yarn install                     # Install project dependencies listed in package.json
$ yarn start                       # Compiles the app and opens it in a browser with "live reload"

Then open http://localhost:3000/ to see your app.

How to Test

$ yarn lint                        # Check JavaScript and CSS code for potential issues
$ yarn fix                         # Attempt to automatically fix ESLint warnings
$ yarn test                        # Run unit tests. Or, `yarn test -- --watch`

How to Deploy

$ yarn build                      # Build the app for production
$ firebase deploy                 # Deploy to Firebase

License

♥