flybase/ftyp-client repository overview

⁠Fast Track Your Paper

⁠QuickStart

git clone https://github.com/FlyBase/fast-track-your-paper
cd fast-track-your-paper

⁠Development Guidelines

1. Install git-flow⁠
2. Use git-flow conventions

• Using git-flow to automate your git branching workflow⁠
• Vincent Driessen's "git flow" branching model⁠

1. Install / Use yarn⁠

⁠Directory layout

• api - GraphQL API server for PostgreSQL provided by Postgraphile
• db - PostgreSQL docker container related files
• proxy - nginx proxy server to map all HTTP ports behind a single source.
• scripts - Misc scripts.

⁠Client

The FTYP client was bootstrapped with Create React App (CRA). To start developing you will need to install the dependencies and run yarn run start

e.g.

cd fast-track-your-paper/client
yarn install
yarn run start

⁠Create React App Info

This project was bootstrapped with Create React App⁠.

⁠Available Scripts

In the project directory, you can run:

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

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

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

⁠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⁠