JamesG Trading is a platform developed by James Gallagher that facilitates and processes investments in him, as a publicly traded person.
There are two options for installation:
git clone https://github.com/jamesgallagher432/jamesg-trading-client.git
npm run setup
Create environment file
In order for the server and client to know how to call the API used in this project, you need to complete this file. We've included a
.env.example file that you can rename to get started with the default values.
cp .env.example .env
Export environmental variables
Run the command
source .env to ensure that environmental variables are stored on your machine.
Run development server
npm run start
Your app will be served at: http://localhost:1337
You can deploy this application on Heroku by using the above link, or run it on your local machine using the instructions above.
The deploy script is now totally automated and will hook into the server-rendering automatically. Running
npm run serve:bundle will set your environment to production and serve these files via Express. Also, a Procfile is included, which will run the Express server on Heroku when you push your code.
Some files left out for brevity. Below you can find the basic file structure used for this application.
. ├── README.md ├── LICENSE ├── index.html ├── package.json ├── webpack.config.js ├── app/ | ├── fonts | ├── images | ├── src | | ├── components | | | ├── FeatureFirstComponent | | | | ├── index.js | | | | ├── index.module.scss | | | | └── tests | | | | | └── index.test.js | | | ├── styles.js | | | ├── index.modules.scss | | | └── index.js | | ├── containers | | | ├── FeatureFirstContainer | | | | ├── index.js | | | | ├── index.module.scss | | | | ├── styles.js | | | └── index.js | | ├── pages | | ├── store | | ├── utils | | └── index.js | └── styles ├── .eslintignore ├── .eslintrc ├── .gitattributes └── .gitignore
npm run setup
npm run build
npm run dev
npm run lint
npm run deploy
npm run clean
npm run serve:bundle
The boilerplate contains generators for easy project scaffolding. At the moment, the generator has the following scaffold generating commands built in:
npm run generate:container
Awesome, which converts to:
npm run generate:component
npm run generate:page
To run the generators with a list of options, run
npm run generate
Follow the on screen prompts to select the options you wish to use.
For convenience, you can bypass the initial selection and scaffold out containers, components and pages by running
npm run generate:<type_of_component>
where <type_of_component> is one of: component, container or page.
The generators use the same feature-first file organization as the rest of the project, encapsulating components within their own folder.
This project is licensed under the MIT License - see the LICENSE.md file for details
Thank you to the Scalable React Boilerplate community for developing such a useful and swift starting point for building an application with React, Grommet, and GraphQL. This README includes content from the Scalable React Boilerplate to make it easy for you to understand how to get started with this project.
Thanks to Mike Merrill, the world's first publicly traded person, for providing me with advice on how to execute this project, and being a true inspiration to me.