|
1 | | -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
| 1 | +# Codeuino Website |
2 | 2 |
|
3 | | -## Available Scripts |
| 3 | +Offical site for Codeuino landing page. Please visit [http://www.codeuino.org/](http://www.codeuino.org/) |
4 | 4 |
|
5 | | -In the project directory, you can run: |
| 5 | +### Table of contents |
6 | 6 |
|
7 | | -### `npm start` |
| 7 | + - Requirements |
| 8 | + - Installation |
| 9 | + - File Structure |
| 10 | + - How to contribute |
| 11 | + - Credits |
| 12 | + |
| 13 | + ## Requirements |
| 14 | + Following applications are required to run the application locally. |
| 15 | + |
| 16 | + - Git |
| 17 | + - Npm |
| 18 | + - Node |
8 | 19 |
|
9 | | -Runs the app in the development mode.<br /> |
10 | | -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
| 20 | +## Installation |
| 21 | +To run the application on your local system follow these steps |
11 | 22 |
|
12 | | -The page will reload if you make edits.<br /> |
13 | | -You will also see any lint errors in the console. |
| 23 | + 1. <code>git clone https://github.com/codeuino/website-www.codeuino.org.git</code> |
| 24 | + 2. Move to the project directory. |
| 25 | + 3. <code>git checkout development</code> |
| 26 | + 4. <code>npm install</code> |
| 27 | + 5. Open <code>localhost:3000</code> to view the website on your local browser. |
14 | 28 |
|
15 | | -### `npm test` |
| 29 | +## File Structure |
16 | 30 |
|
17 | | -Launches the test runner in the interactive watch mode.<br /> |
18 | | -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
| 31 | +This section describes about the file structure of the project. |
| 32 | +All the source code is located in <code>src</code> directory. |
| 33 | +There are two main directories in the src folder, <code>components</code> and <code>pages</code>. |
| 34 | +The pages directory contains all the source code of routes in separate folders. |
| 35 | +The components directory contains all reusable component file in separate folders. |
19 | 36 |
|
20 | | -### `npm run build` |
| 37 | +## How to contribute |
21 | 38 |
|
22 | | -Builds the app for production to the `build` folder.<br /> |
23 | | -It correctly bundles React in production mode and optimizes the build for the best performance. |
| 39 | +### Opening an issue |
24 | 40 |
|
25 | | -The build is minified and the filenames include the hashes.<br /> |
26 | | -Your app is ready to be deployed! |
| 41 | +[](https://github.com/codeuino/website-www.codeuino.org/issues)  |
27 | 42 |
|
28 | | -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
| 43 | +You should usually [open an issue](https://github.com/codeuino/website-www.codeuino.org/issues/new) in the following situations: |
29 | 44 |
|
30 | | -### `npm run eject` |
| 45 | +* Report an error you can’t solve yourself |
| 46 | +* Discuss a high-level topic or idea (for example, community, vision or policies) |
| 47 | +* Propose a new feature or other project idea |
31 | 48 |
|
32 | | -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** |
| 49 | +**Tips for communicating on issues:** |
33 | 50 |
|
34 | | -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. |
| 51 | +If you see an open issue that you want to tackle, comment on the issue to let people know you’re on it. That way, people are less likely to duplicate your work. |
| 52 | +If an issue was opened a while ago, it’s possible that it’s being addressed somewhere else, or has already been resolved, so comment to ask for confirmation before starting work. |
| 53 | +If you opened an issue, but figured out the answer later on your own, comment on the issue to let people know, then close the issue. Even documenting that outcome is a contribution to the project. |
35 | 54 |
|
36 | | -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. |
| 55 | +### Opening a pull request |
37 | 56 |
|
38 | | -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. |
| 57 | +[](http://makeapullrequest.com)   |
39 | 58 |
|
40 | | -## Learn More |
| 59 | +You should usually open a pull request in the following situations: |
41 | 60 |
|
42 | | -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
| 61 | +* Submit trivial fixes (for example, a typo, a broken link or an obvious error) |
| 62 | +* Start work on a contribution that was already asked for, or that you’ve already discussed, in an issue |
| 63 | +A pull request doesn’t have to represent finished work. It’s usually better to open a pull request early on, so others can watch or give feedback on your progress. Just mark it as a “WIP” (Work in Progress) in the subject line. You can always add more commits later. |
43 | 64 |
|
44 | | -To learn React, check out the [React documentation](https://reactjs.org/). |
| 65 | +## Credits |
45 | 66 |
|
46 | | -### Code Splitting |
47 | | - |
48 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting |
49 | | - |
50 | | -### Analyzing the Bundle Size |
51 | | - |
52 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size |
53 | | - |
54 | | -### Making a Progressive Web App |
55 | | - |
56 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app |
57 | | - |
58 | | -### Advanced Configuration |
59 | | - |
60 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration |
61 | | - |
62 | | -### Deployment |
63 | | - |
64 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/deployment |
65 | | - |
66 | | -### `npm run build` fails to minify |
67 | | - |
68 | | -This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify |
| 67 | +This project is currently maintained by [Jaskirat Singh](https://github.com/jaskirat2000) . |
0 commit comments