Skip to content

Latest commit

 

History

History
146 lines (88 loc) · 2.97 KB

README.md

File metadata and controls

146 lines (88 loc) · 2.97 KB
Raw

This is a static version of the new IEJL website that is still under construction. UI/UX was prepared by designer and content creator teams. Final designs can be seen in the mockups folder. Components that I have created are:

Project was created using Gatsby and it works best with Yarn. On Windows machines Gatsby might need remote WSL connection for best results.

On WSL, be sure to install packages with admin privilages $sudo

IEJL

How To Use 🔧

Then you can install the dependencies either using NPM or Yarn:

Using NPM:

# Install dependencies
$ npm install

# Start development server
$ npm run develop

Using Yarn:

# Install dependencies
$ yarn

# Start development server
$ yarn develop

NOTE: If your run into issues installing the dependencies such as Sharp, use this command:

# Install dependencies with all permissions
$ sudo npm install --unsafe-perm=true --allow-root

OR

$sudo yarn

Project Description

Welcome to the IEJL frontend repository. Documentation can be found in the docs folder at the root of this repository.

Getting Started

We have documentation in the works.

Contributing to IEJL Frontend

  1. Get a Browser (Chrome or Opera preferred)
  2. Environment Setup
  3. Configure IDE
  4. Clone the project into your local environment
  5. CI/CD Workflow
  6. Submitting Changes

Code Maintenance

  1. Setup Netlify
  2. Deploying to production
  3. IEJL high-level system architecture
  4. Serverless Roadmap from CPanel

Dependencies

how_to_begin.md

Before You Start

We have an opinionated development environment to minimize the number of issues that will arise from different operating systems.

See docs/quick-start.md before continuing any further.

How to Run

$ yarn
$

Available Scripts

In the project directory, you can run:

yarn develop

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.
See the section about running tests for more information.

yarn 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!

See the section about deployment for more information.

Help

Work in Progress


TBD

Authors

Version History

  • 1.0.0

  • Initial Release

  • Migration from PHP views to Gatsby project

License

TBD. Recommended MIT to open source.

Acknowledgments

Inspiration, code snippets, etc. Tbddit](https://stackedit.io/).