Skip to content

Commit 8b3c5d9

Browse files
authored
Update README.md
1 parent 5a77cf9 commit 8b3c5d9

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

README.md

+41-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
1-
This revolutionary tool will help you make professional, high-quality posters and trailers for your local KCSOC without you needing to have any photo/video editing skills whatsover! New features are planned to be added soon. If you come across any bugs or have some feedback, please email [email protected].
1+
<img src="https://imgur.com/dziDzkS.png" alt="KCSOC Studio Logo" width="400px" />
2+
3+
## Introduction
4+
Welcome to the official repository for KCSOC Studio.
5+
6+
This revolutionary tool will help you make professional, high-quality posters and trailers for your local KCSOC without you needing to have any photo/video editing skills whatsover! New features are planned to be added soon. Feel free to report any bugs/issues or create pull requests.
7+
8+
This project was built using **ReactJS** & **Material-UI**, and uses the following API's:
9+
10+
- **Dropbox API** to get design files when creating posters using a tempalte
11+
- **Pexels API** to get video clips when creating trailers
12+
- **Pixabay API** to search for images when creating posters
13+
- **Shotstack API** to edit and render videos
14+
15+
## Website Link
16+
Check out the live version of KCSOC Studio at:
17+
18+
https://kcsocstudio.hershkat.com
19+
20+
## Screenshots
21+
22+
| Landing | Image Search | Final Creation. |
23+
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
24+
| ![](https://imgur.com/QZkXRLQ.png) | ![](https://imgur.com/3JjZhy3.png) | ![](https://imgur.com/G76OeSp.png) |
25+
26+
## Building from source
27+
28+
If you want to build and run this project from source, you can download this repo and use these commands in the working directory:
29+
30+
### `npm start`
31+
32+
Runs the app in the development mode.<br />
33+
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
34+
35+
The page will reload if you make edits.<br />
36+
You will also see any lint errors in the console.
37+
38+
### `npm run build`
39+
40+
Builds the app for production to the `build` folder.<br />
41+
It correctly bundles React in production mode and optimizes the build for the best performance.

0 commit comments

Comments
 (0)