-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #44 from developmentseed/develop
Deploy v0.2
- Loading branch information
Showing
43 changed files
with
1,417 additions
and
551 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Development | ||
|
||
## Installation | ||
The steps below will walk you through setting up your own instance of the project. | ||
|
||
### Install Project Dependencies | ||
To set up the development environment for this website, you'll need to install the following on your system: | ||
|
||
- [Node](http://nodejs.org/) (see [.nvmrc](./.nvmrc)) (To manage multiple node versions we recommend [nvm](https://github.com/creationix/nvm)) | ||
- [Yarn](https://yarnpkg.com/) Package manager | ||
|
||
### Install Application Dependencies | ||
|
||
If you use [`nvm`](https://github.com/creationix/nvm), activate the desired Node version: | ||
|
||
``` | ||
nvm install | ||
``` | ||
|
||
Install Node modules: | ||
|
||
``` | ||
yarn install | ||
``` | ||
|
||
## Running the project locally | ||
|
||
``` | ||
yarn serve | ||
``` | ||
|
||
Compiles the javascript and launches the server making the site available at `http://localhost:9000/` | ||
The system will watch files and execute tasks whenever one of them changes. | ||
The site will automatically refresh since it is bundled with livereload. | ||
|
||
*Known limitation* - changes to the Mapbox Styles do not trigger a reload. As a workaround, you can save one of the `.yml` files instead. | ||
|
||
## Deployment | ||
To prepare the app for deployment run: | ||
|
||
``` | ||
yarn build | ||
``` | ||
This will package the app and place all the contents in the `public` directory. | ||
The app can then be run by any web server. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,52 +1,5 @@ | ||
# Africa Electrification Platform | ||
Description to come. | ||
The Africa Electrification Platform showcases geospatial electrification analysis conducted by the GEPAR team at the World Bank. | ||
|
||
## Installation and Usage | ||
The steps below will walk you through setting up your own instance of the project. | ||
|
||
### Install Project Dependencies | ||
To set up the development environment for this website, you'll need to install the following on your system: | ||
|
||
- [Node](http://nodejs.org/) (see [.nvmrc](./.nvmrc)) (To manage multiple node versions we recommend [nvm](https://github.com/creationix/nvm)) | ||
- [Yarn](https://yarnpkg.com/) Package manager | ||
|
||
### Install Application Dependencies | ||
|
||
If you use [`nvm`](https://github.com/creationix/nvm), activate the desired Node version: | ||
|
||
``` | ||
nvm install | ||
``` | ||
|
||
Install Node modules: | ||
|
||
``` | ||
yarn install | ||
``` | ||
|
||
### Usage | ||
|
||
#### Starting the app | ||
|
||
``` | ||
yarn serve | ||
``` | ||
Compiles the javascript and launches the server making the site available at `http://localhost:9000/` | ||
The system will watch files and execute tasks whenever one of them changes. | ||
The site will automatically refresh since it is bundled with livereload. | ||
|
||
## Deployment | ||
To prepare the app for deployment run: | ||
|
||
``` | ||
yarn build | ||
``` | ||
This will package the app and place all the contents in the `public` directory. | ||
The app can then be run by any web server. | ||
|
||
## Content validation | ||
The yml files with study configuration can be validated using: | ||
|
||
``` | ||
yarn validate | ||
``` | ||
* interested in configuring a study? Check the [/docs](/docs) section | ||
* want to run the project locally? Check [DEVELOPMENT](/DEVELOPMENT.md) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.