Skip to content

Commit b737531

Browse files
author
Vivek Patel
committed
Updated Readme
1 parent d108b7e commit b737531

File tree

1 file changed

+191
-2
lines changed

1 file changed

+191
-2
lines changed

‎README.md

Lines changed: 191 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,192 @@
1-
# CPU Scheduling Application with React Native
2-
## Operating System Project
1+
<p align="center">
2+
<a href="https://github.com/vivek9patel/CPU-Scheduling-APP-React-Native">
3+
<img src="assets/favicon_main.png" alt="Logo" width="80" height="80">
4+
</a>
35

6+
<h3 align="center">CPU Scheduling APP - Operating System</h3>
7+
8+
<p align="center">
9+
React Native Application to visualize the CPU Scheduling with different Algorithms and Animations.
10+
<br />
11+
<a href="https://github.com/vivek9patel/CPU-Scheduling-APP-React-Native"><strong>Explore the docs »</strong></a>
12+
<br />
13+
<br />
14+
<a target="_blank" href="https://cpuscheduling-app.web.app/">View Demo</a>
15+
·
16+
<a target="_blank" href="https://github.com/vivek9patel/CPU-Scheduling-APP-React-Native/issues">Report Bug</a>
17+
·
18+
<a target="_blank" href="https://github.com/vivek9patel/CPU-Scheduling-APP-React-Native/issues">Request Feature</a>
19+
·
20+
<a target="_blank" href="https://cpuscheduling-app.web.app/cpu_scheduling_app.apk">Install App</a>
21+
</p>
22+
</p>
23+
24+
<!-- TABLE OF CONTENTS -->
25+
<details open="open">
26+
<summary><h2 style="display: inline-block">Table of Contents</h2></summary>
27+
<ol>
28+
<li>
29+
<a href="#about-the-project">About The Project</a>
30+
<ul>
31+
<li><a href="#built-with">Built With</a></li>
32+
</ul>
33+
</li>
34+
<li>
35+
<a href="#getting-started">Getting Started</a>
36+
<ul>
37+
<li><a href="#prerequisites">Prerequisites</a></li>
38+
<li><a href="#installation">Installation</a></li>
39+
</ul>
40+
</li>
41+
<li><a href="#usage">Usage</a></li>
42+
<li><a href="#contributing">Contributing</a></li>
43+
<li><a href="#contact">Contact</a></li>
44+
</ol>
45+
</details>
46+
47+
<!-- ABOUT THE PROJECT -->
48+
49+
## About The Project
50+
51+
<img src="assets/splash.png" width="200"/>
52+
<h4>
53+
54+
</h4>
55+
56+
### Algorithms
57+
58+
- FCFS Algorithm
59+
- SJF Algorithm
60+
- SRTF Algorithm
61+
- Round Robin Algorithm
62+
- LJF Algorithm
63+
- LRTF Algorithm
64+
- Priority Scheduling (Preemptive)
65+
- Priority Scheduling (Non-Preemptive)
66+
67+
### Features
68+
69+
- 8 CPU Scheduling Algorithms
70+
- Each algorithm with IO Burst
71+
- Gannt chart
72+
- Animation of what happens in CPU and Waiting Queue
73+
- History Tab to store previously input data
74+
- Haptic feedbacks
75+
76+
### Built With
77+
78+
- [React Native](https://reactnative.dev/)
79+
- [Expo](https://expo.io/)
80+
- [Gradle](https://gradle.org/)
81+
82+
<!-- GETTING STARTED -->
83+
84+
## Getting Started
85+
86+
To get a local copy up and running follow these simple steps.
87+
88+
### Prerequisites
89+
90+
Install latest npm version on your system.
91+
92+
- npm
93+
94+
```sh
95+
npm install npm@latest -g
96+
```
97+
98+
Check the version by running this command.
99+
100+
- npm version
101+
```sh
102+
npm -v
103+
```
104+
I used expo-cli for this project,if you want to build the project with expo install expo-cli on your system
105+
- expo cli
106+
```sh
107+
npm install --global expo-cli
108+
```
109+
110+
If installation gives you error like this,
111+
112+
- ```sh
113+
npm ERR! code EACCES
114+
npm ERR! syscall access
115+
npm ERR! path /usr/local/lib/node_modules/expo-cli
116+
npm ERR! errno -13
117+
npm ERR! Error: EACCES: permission denied,...
118+
```
119+
You have to give root permission ,like for linux:
120+
- ```sh
121+
sudo npm install --global expo-cli
122+
```
123+
124+
### Installation
125+
126+
1. Clone the repo
127+
```sh
128+
git clone https://github.com/vivek9patel/CPU-Scheduling-APP-React-Native.git
129+
```
130+
2. Install Expo packages
131+
```sh
132+
npm install expo
133+
```
134+
135+
- Now your project folder should look like this :
136+
```sh
137+
└── CPU-Scheduling-APP-React-Native-master
138+
├── App.js
139+
├── app.json
140+
├── assets
141+
├── babel.config.js
142+
├── models
143+
├── node_modules
144+
├── package.json
145+
├── package-lock.json
146+
├── README.md
147+
├── routes
148+
└── screens
149+
```
150+
151+
<!-- USAGE EXAMPLES -->
152+
153+
## Usage
154+
155+
- You can run this project by starting the metro server
156+
157+
```sh
158+
npm start
159+
```
160+
161+
or
162+
163+
```sh
164+
expo start
165+
```
166+
167+
- If you are using expo , you can debug the project by installing expo app on your mobile devices & scanning the QR code.
168+
169+
- [Expo App Android](https://play.google.com/store/apps/details?id=host.exp.exponent&referrer=www‎)
170+
- [Expo App IOS](https://apps.apple.com/app/apple-store/id982107779)
171+
172+
- You can also debug the application by running the emulators on your systems.
173+
174+
<!-- CONTRIBUTING -->
175+
176+
## Contributing
177+
178+
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
179+
180+
1. Fork the Project
181+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
182+
3. Commit your Changes (`git commit -m 'Added some AmazingFeature'`)
183+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
184+
5. Open a Pull Request
185+
186+
<!-- CONTACT -->
187+
188+
## Contact
189+
190+
Vivek Patel - [@vivek9patel-linkedlin](https://www.linkedin.com/in/vivek9patel/) | [email protected]
191+
192+
Project Link: [https://github.com/vivek9patel/CPU-Scheduling-APP-React-Native](https://github.com/vivek9patel/CPU-Scheduling-APP-React-Native)

0 commit comments

Comments
 (0)