Skip to content
This repository has been archived by the owner on Apr 26, 2023. It is now read-only.

tedconf/tedconf.github.io

Repository files navigation

TED Open Source homepage

This is the source code for tedconf.github.io, an index of TED's open source projects.

NOTE: Development is on the source branch, deployed build is on the master branch.

This project was bootstrapped with Create React App.

To Add/Update a Project

Add the project and details as a JSON object in the appropriate project group's "projects" array in src/data/projects.json.

Then yarn build and deploy to master branch.

TODO: Deploy docs? The Ember-based deploy stuff seemed extra complicated, but nothing has been done to script the delivery of the build output to the master branch root.

Project Component Structure

The rendering tree looks something like this. A few notes on notation:

  • Data imports are shown in parens next to the component that imports the data file.
  • A + next to the component means many of those are potentially rendered depending on props.
index.js
'- src/components/App (<- src/data/projects.json)
    |- src/components/AppHeader
    |- src/components/ProjectGroups
    |   '- src/components/ProjectGroup +
    |       '- src/components/ProjectCard +
    '- src/components/Footer (<- src/data/footer-links.json)

Available Scripts

In the project directory, you can run:

npm start or 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.

npm test or yarn test

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

npm run build or yarn 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.

npm run deploy or yarn run deploy

Note: this has not been tested yet!

Based on this: https://facebook.github.io/create-react-app/docs/deployment#github-pages-https-pagesgithubcom

This uses the gh-pages package to build the app and push the built code to master branch.

npm 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.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify