Skip to content

Latest commit

 

History

History
107 lines (62 loc) · 4.62 KB

README.md

File metadata and controls

107 lines (62 loc) · 4.62 KB

Spaceport

This repository is part of the RCOS Open Source Curriculum Project. View the main repository for system-level documentation. This repository contains only the frontend website. Students can view project details from this frontend website.

github meme

This project was bootstrapped with Create React App.

Technologies

  • Spaceport uses the Yarn package manager
  • ReactJS

Getting Started

  1. Ensure Node is installed by running npm --version. You should see a number like 6.4.1. If not, install the latest LTS version of NodeJS.
  2. Ensure Yarn is installed by running yarn --version. You should see a number like 1.7.0. If not, install it using the command npm i -g yarn.
  3. Clone this repository into whatever folder you want using git clone [url]. I highly recommend using ssh to work with GitHub, but https will work fine if you're just starting out.
  4. Move into the project directory using cd spaceport.
  5. Install dependencies using yarn install
  6. Start the development server using yarn start
  7. Admire your work by viewing http://localhost:3000 in your browser.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Things You Probably Shouldn't Do

Pusing directly to master

push force meme

This is how to get fired from an internship in a single command: git push origin master -f.

This is one of the only ways in Git that you can overwrite and/or destroy other people's work.

The correct thing to do is to create a branch, work on that branch, then merge that branch via a pull request.

Not writing unit tests

unit test meme

If you don't write automated tests, nobody else will know if your code works or not.

Not writing documentation

documentation meme

If you don't document your code, nobody will know what you were thinking. There's also a decent change you will forget if you leave the code alone for a few weeks.

Get sucked into the enterprise development world

enterprise dev call for help

Checkout Steve Ballmer of Microsoft talk about developers.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Past Contributors

Add your name here if you're committing changes to this repository.