Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codeuino/website-www.codeuino.org
https://github.com/codeuino/website-www.codeuino.org
css hacktoberfest hacktoberfest2020 html react react-native site ui-components ux-design
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/codeuino/website-www.codeuino.org
- Owner: codeuino
- Created: 2018-05-29T18:53:49.000Z (over 6 years ago)
- Default Branch: development
- Last Pushed: 2020-10-11T07:31:12.000Z (about 4 years ago)
- Last Synced: 2024-02-24T18:34:31.087Z (9 months ago)
- Topics: css, hacktoberfest, hacktoberfest2020, html, react, react-native, site, ui-components, ux-design
- Language: JavaScript
- Homepage: http://www.codeuino.org/
- Size: 64.9 MB
- Stars: 34
- Watchers: 11
- Forks: 73
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Codeuino Website
Official site for Codeuino landing page. Please visit [http://www.codeuino.org/](http://www.codeuino.org/)
## Table of contents
- Requirements
- Installation
- File Structure
- How to contribute
- Credits
## Requirements
Following applications are required to run the application locally.
- Git
- Npm
- Node
## Installation
To run the application on your local system follow these steps
1. `git clone https://github.com/codeuino/website-www.codeuino.org.git`
2. Move to the project directory.
3. `git checkout development`
4. `npm install`
5. `npm run build`
6. `npm start`
7. Open `localhost:5000` to view the website on your local browser.
## File Structure
This section describes about the file structure of the project.
All the source code is located in `src` directory.
There are two main directories in the src folder, `components` and `pages`.
The pages directory contains all the source code of routes in separate folders.
The components directory contains all reusable component file in separate folders.
## Dockerizing the application
### To use the application in docker for both production and development use, follow
- Build and tag docker image ` docker image build -f Dockerfile-dev -t {name-of-docker-file-of-your-choice} . `
- Running docker image ` lakshyadocker run -it -v ${PWD}:/app -v /app/node_modules -p {Port-you-want-your-app-on}:3000 --rm {docker-image} `
## How to contribute
### Opening an issue
[](https://github.com/codeuino/website-www.codeuino.org/issues) 
You should usually [open an issue](https://github.com/codeuino/website-www.codeuino.org/issues/new) in the following situations:
- Report an error you can’t solve yourself
- Discuss a high-level topic or idea (for example, community, vision or policies)
- Propose a new feature or other project idea
**Tips for communicating on issues:**
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.
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.
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.
### Opening a pull request
[](http://makeapullrequest.com)  
You should usually open a pull request in the following situations:
- Submit trivial fixes (for example, a typo, a broken link or an obvious error)
- Start work on a contribution that was already asked for, or that you’ve already discussed, in an issue
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.
## Credits
This project is currently maintained by [Jaskirat Singh](https://github.com/jaskirat2000) .
---
[](https://twitter.com/codeuino) [](https://github.com/codeuino/Social-Platform-Donut)