Skip to content

Latest commit

 

History

History
136 lines (97 loc) · 4.91 KB

README.md

File metadata and controls

136 lines (97 loc) · 4.91 KB

COMP90020-Raft-Web

This is a distributed web-based e-book system where any user can publish and read books on the webpage. The objective of the system is to assist book publishing. Different from the traditional publishing process, authors can update their books chapter by chapter. And users can read them immediately without waiting for the entire book to be published.

Project Structure

All source code are contained in the src folder

the api folder conatins all functions that are used to connect backend API

the components folder contains all react components we used, with each sub-folder representing a component

the pages folder contains all react pages object

~/COMP90020-RAFT-WEB/APP/SRC
│   App.css
│   App.js
│   App.test.js
│   index.css
│   index.js
│   logo.svg
│   reportWebVitals.js
│   setupTests.js
│
├───api
│       book.js
│       raft.js
│       socket.js
│       util.js
│
├───components
│   ├───Book
│   │       Book.css
│   │       Book.jsx
│   │
│   ├───Chapter
│   │       Chapter.css
│   │       Chapter.jsx
│   │
│   ├───Common
│   │       InputField.jsx
│   │
│   ├───CreateBook
│   │       CreateBook.css
│   │       CreateBook.jsx
│   │
│   ├───EditChapter
│   │       EditChapter.jsx
│   │
│   ├───NavBar
│   │       NavBar.css
│   │       NavBar.jsx
│   │
│   └───ServerLogs
│           ServerLogs.css
│           ServerLogs.jsx
│
└───pages
    ├───BookDetail
    │       BookDetail.css
    │       BookDetail.jsx
    │
    └───Homepage
            Homepage.jsx

How to run the app

First navigate to the app folder

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open 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.

npm test

Launches the test runner in the interactive watch mode.
See the section about 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 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.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: 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

Making a Progressive Web App

This section has moved here: 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

Deployment

This section has moved here: 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