-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b29f176
commit dfafdd7
Showing
1 changed file
with
37 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,50 @@ | ||
| # Getting Started with Create React App | ||
| # Geenie: The AstroSAT Visualizer Webtool | ||
|
|
||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
| ## Requirements | ||
| Geenie is built upon [React JS](https://reactjs.org), and [Material UI]() library that was mainly used for components, templates and pages. Also, for sky mapping, [Aladin API]() | ||
| was used. This API was successfully integrated in the frontend UI as a ReactJS component, despite of it being an archaic and purely HTML component. | ||
|
|
||
| ## Available Scripts | ||
| ## Installation | ||
| To get the project up and running, and view it in the browser, complete the following steps: | ||
|
|
||
| In the project directory, you can run: | ||
| 1. Download and install Node: <https://nodejs.org/> | ||
| 2. Clone this repo: `git clone git@github.com:kartikcode/AstroSAT-Visualization-Tool.git` (SSH) or `git clone https://github.com/kartikcode/AstroSAT-Visualization-Tool.git` (HTTPS) | ||
| 3. Install project dependancies: `npm install` | ||
| 4. Start the development environment: `npm start` | ||
| 5. Open your browser and visit <http://localhost:3000> | ||
|
|
||
| ### `yarn start` | ||
| ## Development | ||
| When developing components, you may want assets automatically compiled and the browser to refresh automatically. To do this, run the following task: | ||
|
|
||
| Runs the app in the development mode.\ | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
| * `npm run dev` | ||
|
|
||
| The page will reload if you make edits.\ | ||
| You will also see any lint errors in the console. | ||
| ## Creating a static build | ||
| To create a static instance of this project, run the following task: | ||
|
|
||
| ### `yarn test` | ||
| * `npm run build` | ||
|
|
||
| Launches the test runner in the interactive watch mode.\ | ||
| See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
| This will create a folder called `www`, into which the required files will be created. | ||
|
|
||
| ### `yarn build` | ||
| ## Deployment | ||
| To make this project publicly accessible, you can deploy a static instance by running the following task: | ||
|
|
||
| Builds the app for production to the `build` folder.\ | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
| * `npm run publish` | ||
|
|
||
| The build is minified and the filenames include the hashes.\ | ||
| Your app is ready to be deployed! | ||
| This will publish the contents of `public` to your `gh-pages` branch. | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
| ## Repo structure | ||
| Sometimes it’s helpful to know what all these different files are for… | ||
|
|
||
| ### `yarn 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](https://facebook.github.io/create-react-app/docs/getting-started). | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
|
|
||
| ### Code Splitting | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](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](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](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](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](https://facebook.github.io/create-react-app/docs/deployment) | ||
|
|
||
| ### `yarn build` fails to minify | ||
|
|
||
| This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) | ||
| ``` | ||
| / | ||
| ├─ src/ | ||
| │ ├─ components/ # Components | ||
| │ │ ├─ Aladin/ # …that render Aladin sky map | ||
| │ │ ├─ Cards/ # …that appears as the Sidebar | ||
| │ │ ├─ ModalCard/ # …that appear as a popup on first visit | ||
| │ │ ├─ Topbar/ # …that renders the Topbar | ||
| ├─ .eslintrc # Linting preferences for JavasScript | ||
| ├─ LICENSE # License information for this project | ||
| ├─ package.json # Project manifest | ||
| └─ README.md # This file | ||
| ``` |