Skip to content
This repository has been archived by the owner on Sep 8, 2020. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Wal Wal authored Jun 7, 2019
1 parent 26dc711 commit 4f6e128
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,42 @@
# cuHacking: Promo Website

Temporary landing page used while the full website is under construction. Built in React using create-react-app.
Temporary landing page used while the full website is under construction. Built in [React](https://reactjs.org/) using [create-react-app](https://github.com/facebook/create-react-app).


## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Installing
This project uses node package manager (npm). First, **install all required dependencies with:**

First you will need to clone this project to your machine.
Next you will need to install dependencies. This project uses yarn. Navigate to the root of the repo and run
```
yarn
```
or
```
npm install
yarn install
```

### Testing
To **run the development server** on [localhost:3000](localhost:3000) *(includes hot-reload)*:

Run the development server with
```
npm start
yarn start
```
The server runs on [localhost:3000](localhost:3000).

### Building
To **create an optimized production build:**

Create an optimized production build with
```
npm run build
yarn build
```

To **test the production build** (visible at [localhost:5000](localhost:5000)):

Test your production build with
```
serve -s build
```

## Deployment

*Coming Soon*
```
and navigate to [localhost:5000](localhost:5000).

## Built With
## Packages

* [Reactjs](https://reactjs.org/docs/getting-started.html)
* [create-react-app](https://github.com/facebook/create-react-app)
Expand Down

0 comments on commit 4f6e128

Please sign in to comment.