praneeth-rdy / comic-creator-frontend

Comic Creator Web Application

Report Bug · Request Feature

Table of Contents

• Development
  • Setting Up Locally
• Project Structure
  • File Structure
  • Libraries/Frameworks Used
• Author Contact
• Acknowledgements

(back to top)

Development

Setting Up Locally

The following setup helps you run the application on your local machine. It assumes that you have Nodejs installed on your computer. If not, install Nodejs from https://nodejs.org/en/download/ and yarn package manager (optional).

1. Clone the repository

git clone [e-mail]:praneeth-rdy/comic-creator-frontend.git

You can also use https to clone the repository. To know more read this documentation.

2. Now change the directory by navigating into the cloned repository. Use the following command, in case of linux.

cd comic-creator-frontend

3. Update the value of router basename to / in src/routes/AppRouterProvider.js.

4. Install the dependencies using yarn (you can also use npm).

yarn install

5. Start the react server.

yarn start

(back to top)

Project Structure

File Structure

.
├── public
└── src
   ├── assets
   ├── components
   ├── pages
   ├── routes
   ├── styles
   ├── utilities
   └── index.js

• public: Contains public files such as index.html.
• src: Contains source files (js, css, assets, etc.)
  • assets: Contains image and icons.
  • components: Contains reusable react components.
  • pages: Contains all pages.
  • routes: Contains custom routes.
  • styles: Contains all stylesheets (CSS).
  • utilities: Contains commonly used util functions.
  • index.js: Contains the top-level wrapper component.

Libraries/Frameworks Used

This project has been built with the following technologies.

• React
• React Router

(back to top)

Author Contact

Name: Kolanu Praneeth Reddy
Roll Number: 19AE30030
Email: [e-mail]
Phone: [phone]

(back to top)

Acknowledgements

• GitHub Pages

(back to top)