Git Product home page Git Product logo

data-exchange-helpdesk-prototype's Introduction

Making changes to this prototype

Set up Git

In order to work on the prototype and make changes to it, you must set up Git. Git is a version control scheme where changes from multiple users can be compiled together to create a release.

The Git hosting provider we use for this prototype is GitHub. To get started, follow the these steps:

  1. Set up an account on GitHub with your education.gov.uk email address, or use an existing GitHub account.
  2. Request access to the DfE-Digital organisation, ask a colleague using Slack or internal means to be invited.
  3. Accept the invitation to the organisation by finding the DfE-Digital organisation in GitHub. If the invitation was sent successfully there will be a banner at the top of the page asking you to accept the invitation, follow the instructions to do so.
  4. Download GitHub Desktop, or, you can use the command line if you feel comfortable enough.
  5. Open GitHub Desktop and sign in to your GitHub account.
  6. Go to the repository page.
  7. Click the green 'clone or download' button.
  8. Click 'Open in Desktop'
  9. Choose a location on your computer to save it to.

Set up authoring tool

Download a code editor, for example, Visual Studio Code or Atom.

Install Node.js

Go to [https://nodejs.org/en/] and follow the instructions for set up.

Install modules

  1. Open a command line tool.
  2. Enter cd <path of prototype folder> then press enter.
  3. Enter npm i then press enter.
  4. Resolve any errors that may arise.

Run prototype

  1. Open a command line tool.
  2. Enter cd <path of prototype folder> then press enter.
  3. Enter npm start then press enter.
  4. Follow the command prompts.

Making changes

Now the prototype is running you can make changes to any files and view the changes at http://localhost:3000 (or whichever domain the command prompt shows. When making changes you will notice that the changes show up in the browser. Once you have finished making changes you must save the file to see the result.

Committing changes

When you have made the neessseary changes you must now commit them. Return to GitHub Desktop. Any changed files will now be 'queued up' to send over to the GitHub repository. In order for them to become live you must 'push' the files up to the repository. In order to do this, follow the on screen commands.

When changes have been 'pushed' to the repository you can see the changes in the live prototype on Heroku, it may take a few minutes for the changes to show up on the live version.

data-exchange-helpdesk-prototype's People

Contributors

daviddotto avatar

Watchers

James Cloos avatar Daniel Rothig avatar Simon Bull avatar  avatar

Forkers

uk-gov-mirror

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.