Giter Club home page Giter Club logo

data-portal's Introduction

HCA Data Portal

Developer Workspace

Requirements

Setup

Clone Repo

Clone the data-portal repo:

[email protected]:HumanCellAtlas/data-portal.git
Install git-secrets

If you have push access to the remote, you'll need to install git-secrets, enable the commit hooks for it and configure patterns for AWS and Google:

git secrets --install
git secrets --register-aws
git secrets --add '[-]----BEGIN.PRIVATE.KEY-----'
Install Gatsby Command Line Tool

The Gatsby command line tool is used to develop, build and serve (locally) the Data Portal.

npm install --global gatsby-cli
Install Packages

Run the following command from the project's root directory to install the required packages:

npm install

Development Server

Run the following command from the root directory:

npm start

Or if using Windows:

npm run start-windows

The development server can be viewed at:

localhost:8000

Building

Run the following command to build the application:

npm run build

Or on Windows:

npm run build-windows

Local Production Version

Run the following command to view a built version of the application, locally:

gatsby serve

The built version can be viewed at:

localhost:9000

Application Dependencies

Material Components

HCA Data Preview uses Material Components (https://material.io/components/web/) for its Material Design library.

data-portal's People

Contributors

aqsa-el avatar arctenik avatar brianraymor avatar brucerodrigues avatar chmreid avatar dependabot[bot] avatar dsotirho-ucsc avatar ekiernan avatar esthermcdade avatar frano-m avatar hannes-ucsc avatar hunterckx avatar jpaten avatar kayleemathews avatar kislyuk avatar kmoon3 avatar lanagarmire avatar lauraclarke avatar lelewang111 avatar maryjgoldman avatar matthewspeir avatar millenniumfalconmechanic avatar natanlao avatar nicoleduan9716 avatar noopdog avatar parthshahva avatar pcm32 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

data-portal's Issues

Content Management for the site

Teams create outlines for their content
Jodi designs tone of content
Teams complete first drafts
Leads review content
Jodi edits content for tone
Dave finishes the CMS
Teams input into CMS
Wider review
Final edits

Setup CMS System

Clever Canary will develop a working CMS system for the data portal

Modify Travis scripts to build and deploy the updated site for DEV

So this is using gatsby.js as a site generator for the code in develop branch.

This needs node 10 to install and run
once the npm (dev dependancies) are installed then its..

gatsby build

to build the site that will end up in the public folder.

public then needs to be copied to the S3 bucket and cache refreshed etc.

Right now and will then end up on https://dev.data.humancellatlas.org/

This currently would read only from local markdown, but we can then set up some triggers to get this bit more elaborate and pull form a different repo for the markdown.

Lets discuss when you have a moment.

Create Data Portal Content Repository

Please create a content repo for the data portal maybe data-portal-content that we can use to store the markdown content for the site.

Initially please add me noopdog and the rest of the Clever Canary team team fran and mim.
Once we get this going we can add others.

Thanks!

Edit of content for tone

The first draft of the content is in, comments have been made by the team leads. Now we need to have it all have a consistent voice.

Design tone of content

decide on the tone of the documentation. This can be distributed to content creators, but will definitely be used once the first content comes in.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.