https://github.com/mivladie/shergilldesign

Shergill Design is a web application for an Architecture Services company based in London, UK.
https://github.com/mivladie/shergilldesign

react react-router sass

Last synced: about 1 month ago
JSON representation

Shergill Design is a web application for an Architecture Services company based in London, UK.

• Host: GitHub
• URL: https://github.com/mivladie/shergilldesign
• Owner: MiVladie
• Created: 2020-04-19T15:57:10.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T19:45:22.000Z (about 2 years ago)
• Last Synced: 2023-03-06T11:02:41.592Z (almost 2 years ago)
• Topics: react, react-router, sass
• Language: SCSS
• Homepage: https://mivladie.github.io/shergilldesign/
• Size: 8.94 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# :cherry_blossom: About

Shergill Design is a web application for an Architecture Services company based in London, UK.

Website preview:

https://mivladie.github.io/shergilldesign/

# :memo: Table of Contents

-   [:memo: Table of Contents](#memo-table-of-contents)

-   [:rocket: Quick Start](#rocket-quick-start)

    -   [Step 1: Installing the dependencies](#step-1-installing-the-dependencies)

    -   [Step 2: Launching the server](#step-2-launching-the-server)

-   [:desktop_computer: Installation](#desktop_computer-installation)

    -   [NodeJS](#nodejs)

-   [:keyboard: Available Scripts](#keyboard-available-scripts)

-   [:green_book: Learn More](#green_book-learn-more)

    -   [ReactJS](#reactjs)

    -   [React Router](#react-router)

    -   [Sass](#sass)

# :rocket: Quick Start

> You must have installed all of the software applications in the [installation](#desktop_computer-installation) section.

Quick start guide to set the server up and running.

## Step 1: Installing the dependencies

### Run `npm install`

Installs all of the necessary dependencies.

## Step 2: Launching the server

### Run `npm start`

Starts the server in the development mode.

# :desktop_computer: Installation

In order to run the server, you must have installed all of the necessary software listed below.

## NodeJS

Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.

-   [Download](https://nodejs.org/en/)

# :keyboard: Available Scripts

In the project directory, you can run:

### `npm install`

Installs all of the necessary dependencies.

### `npm start`

Runs the app in the development mode on port `:3000`.

### `npm run build`

Builds the app for production to the `/build` folder.

# :green_book: Learn More

References to the packages used in the project.

## ReactJS

React is a JavaScript library for building user interfaces.

-   [Getting Started](https://reactjs.org/docs/getting-started.html)

## React Router

React Router is a collection of navigational components that compose declaratively with your application.

-   [Quick Start](https://reactrouter.com/web/guides/quick-start)

## Sass

Sass is a preprocessor scripting language that is interpreted or compiled into CSS.

-   [Documentation](https://sass-lang.com/documentation)