Skip to content

Commit

Permalink
Ready to launch
Browse files Browse the repository at this point in the history
  • Loading branch information
siddharthroy12 committed Mar 23, 2022
1 parent e354c4a commit 146ee9d
Show file tree
Hide file tree
Showing 27 changed files with 870 additions and 215 deletions.
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Siddharh Roy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
117 changes: 79 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,111 @@
# Getting Started with Create React App
<div id="top"></div>
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://recoded.netlify.app/">
<img src="public/app_logo.svg" alt="Logo" width="80" height="80">
</a>

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
<h3 align="center">Recoded</h3>

## Available Scripts
<p align="center">
An awesome too make Images and GIFs of your code!
<br />
<br />
<a href="https://github.com/siddharthroy12/recoder/issues">View Demo</a>
·
<a href="https://github.com/siddharthroy12/recoder/issues">Report Bug</a>
·
<a href="https://github.com/siddharthroy12/recoder/issues">Request Feature</a>
</p>
</div>

In the project directory, you can run:

### `yarn start`
<!-- ABOUT THE PROJECT -->
## About The Project

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
![[Project Preview]](./preview.gif)

The page will reload when you make changes.\
You may also see any lint errors in the console.
There are plenty of Apps like this where you can make beautiful images of your code but non of them support making GIFs so I made this.

### `yarn test`
<p align="right">(<a href="#top">back to top</a>)</p>

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.

### `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.
### Built With

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
* [React.js](https://reactjs.org/)
* [DOM to Image](https://github.com/tsayen/dom-to-image)
* [GIFshot](https://yahoo.github.io/gifshot/)

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
<p align="right">(<a href="#top">back to top</a>)</p>

### `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.
<!-- GETTING STARTED -->
## Running App Locally

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.
To get a local copy up and running follow these simple steps.

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.
* Clone this repo (have git installed)
```sh
git clone https://github.com/siddharthroy12/recoder.git
```
* Install dependencies (have nodejs installed)
```sh
cd recoder
npm install # or yarn install
```
* Run
```sh
yarn start
```

## 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
<!-- ROADMAP -->
## Roadmap

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)
- [ ] Add more themes
- [ ] Add cancle record button
- [ ] Make session shareable

### Analyzing the Bundle Size
<p align="right">(<a href="#top">back to top</a>)</p>

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)
<!-- CONTRIBUTING -->
## Contributing

### Advanced Configuration
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

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)
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
### Deployment
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
<p align="right">(<a href="#top">back to top</a>)</p>
### `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)
<!-- LICENSE -->
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
Siddharth Roy - [@reactoverflow](https://twitter.com/reactoverflow) - [email protected]
<p align="right">(<a href="#top">back to top</a>)</p>
8 changes: 5 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
{
"name": "recoded",
"version": "0.1.0",
"private": true,
"version": "1.0.0",
"license": "MIT",
"private": false,
"dependencies": {
"@testing-library/jest-dom": "^5.14.1",
"@testing-library/react": "^12.0.0",
"@testing-library/user-event": "^13.2.1",
"dom-to-image-more": "^2.9.5",
"gifshot": "^0.4.5",
"prismjs": "^1.27.0",
"react": "^17.0.2",
"react-ace": "^9.5.0",
"react-dom": "^17.0.2",
"react-scripts": "5.0.0",
"react-simple-code-editor": "^0.11.0",
"web-vitals": "^2.1.0"
},
"scripts": {
Expand Down
Binary file added preview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
5 changes: 5 additions & 0 deletions public/lang_icons/c.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
Loading

0 comments on commit 146ee9d

Please sign in to comment.