Skip to content

Commit

Permalink
Documentatino formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
zachsa committed May 28, 2021
1 parent 2610269 commit fe8d268
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 11 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ Suite of services - for tracking, analysing, and monitoring climate adaptation a

# Quick start

Setup the repository for development on a local machine. The Node.js and React services are run using a local installation of Node.js, and dependent services (Mongo) are run via Docker containers
Setup the repository for development on a local machine. The Node.js and React services are run using a local installation of Node.js, and dependent services (SQL Server) are run via Docker containers

## System requirements

1. Docker Desktop
2. Node.js **node:14.16.1** (Versions lower than **node:14.13** will not work)
2. Node.js **node:^14.17** (Versions lower than **node:14.13** will not work)

```sh
# Make sure that Node.js ^node:14.16.1 is installed. Follow the instructions at https://github.com/nodesource/distributions/blob/master/README.md#debinstall
# Make sure that Node.js ^node:14.17 is installed. Follow the instructions at https://github.com/nodesource/distributions/blob/master/README.md#debinstall
# Assuming an Ubuntu Linux environment
curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get install gcc g++ make # Required for building node-sass and other modules with native bindings
Expand Down Expand Up @@ -67,9 +67,6 @@ npm run install-dependencies
-d \
mcr.microsoft.com/mssql/server:2017-latest-ubuntu

# Start a MongoDB server
docker run --name mongo --restart always -e MONGO_INITDB_ROOT_USERNAME=admin -e MONGO_INITDB_ROOT_PASSWORD=password -d -p 27017:27017 mongo:4.4.3

# Start the Node.js API server
npm run start:api

Expand Down Expand Up @@ -119,7 +116,6 @@ npm run start:bundled
docker build -t nccrd .

# Create a docker network so that SQL Server is accessible from the docker container

# --network host should work on Linux, but not other OSes where Docker Engine is running virtualized
docker network create --driver bridge nccrd

Expand Down
8 changes: 4 additions & 4 deletions src/client/src/pages/deployments/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ export default () => {
<span>
This page will shows a list of deployments. Each tenant is basically a form that allows for
(1) specifying a project filter (2) uploading a logo and (3) defining a domain name that this
filter will be applied on. This will likely be implemented using the client-info api
address, which will return the hostname that the website is being accessed on. This will then
create a non-editable filter that is applied to projects, and will use the appropriate logo in
the header. Also... might be a good way for specifying backgrounds
filter will be applied on. This will likely be implemented using the client-info api address,
which will return the hostname that the website is being accessed on. This will then create a
non-editable filter that is applied to projects, and will use the appropriate logo in the
header. Also... might be a good way for specifying backgrounds
</span>
)
}

0 comments on commit fe8d268

Please sign in to comment.