nicolabs/Open-Sora
1
0
Fork 0
mirror of https://github.com/hpcaitech/Open-Sora.git synced 2026-04-15 03:15:20 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

added readme

Browse source
This commit is contained in:
FrankLeeeee 2024-04-24 14:11:37 +08:00
parent dd5a4a3062
commit c6edc98f4c
1 changed files with 45 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

107
README.md
View file

@ -1,70 +1,53 @@
# Getting Started with Create React App
# Open-Sora Gallery
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
We rewrite the `nerfies`[https://github.com/google/nerfies] with React to enable people without knowledge in html to edit the web content by simply changing the data files.
## Available Scripts
The web content will display videos given in the `src/data/video.js` file. This file contains a `videos` variable and its structure follows this format:
In the project directory, you can run:
```javascript
[
// video group
{
"title": "group1"
"items": [
// put videos here
{
"prompt": "some descriptions",
"link": "link to the video 1"
},
{
"prompt": "some descriptions",
"link": "link to the video 2"
},
]
},
### `npm start`
// another group of videos
{
"title": "group2"
"items": [
// put videos here
{
"prompt": "some descriptions",
"link": "link to the video 3"
},
{
"prompt": "some descriptions",
"link": "link to the video 4"
},
]
},
]
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
```
The page will reload when you make changes.\
You may also see any lint errors in the console.
If you wish to add another video, just add the following data to the `items` field in a video group.
### `npm test`
```javascript
{
"prompt": "your prompt",
"link": "video url"
}
```
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.
### `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](https://facebook.github.io/create-react-app/docs/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](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)
### `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](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
If you wish to add another video group, just replicate the group structure and edit the video items inside.