Skip to content

Commit

Permalink
docs: add multiple docs
Browse files Browse the repository at this point in the history
add Contributing.md, Code-of-conduct.md, Getting-started-guide.md in docs directory & update .dockerignore
  • Loading branch information
Sunny-unik committed Dec 6, 2023
1 parent c2565dc commit eb240db
Show file tree
Hide file tree
Showing 5 changed files with 168 additions and 3 deletions.
3 changes: 2 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ README.md
.github
Dockerfile
.dockerignore
.env.example
.env.example
docs
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@

## Pull Image

This image is available on [hub.docker.com](https://hub.docker.com). You can pull this image using `docker pull sunnyunik/node-in-ubuntu:tagname`
This image is available on [hub.docker.com](https://hub.docker.com). You can pull this image using `docker pull sunnyunik/node-in-ubuntu:latest`

## 🤝 Contributing

We encourage you to contribute to docker-node-server. Feel free to start a discussion.
We encourage you to contribute to docker-node-server. All contributors are required to abide by our [Code of Conduct](/docs/Code-of-conduct.md). Please check out the [Contributing guide](/docs/Contributing.md) for guidelines about how to proceed with your contribution.
Feel free to start a discussion.

# Deployment

Expand Down
80 changes: 80 additions & 0 deletions docs/Code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
id: code-of-conduct
title: Code of Conduct
sidebar_label: Code of Conduct
keywords:
- code of conduct
---

## Our pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at <sunnygandhwani027@gmail.com>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [https://contributor-covenant.org/version/1/4][version]

[homepage]: https://contributor-covenant.org
[version]: https://contributor-covenant.org/version/1/4/
46 changes: 46 additions & 0 deletions docs/Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing

Thanks for your interest in contributing to docker-node-server.
Contributions are always welcome, no matter how large or small.

If you wish to contribute code, to get started we recommend first reading our [Getting Started Guide](Getting-started-guide.md).

All other documentation for contributors can be found [in the docs directory](./).

## Guidelines

Before contributing, please read the [code of conduct](./code-of-conduct.md) and follow the directions below:

### Recommended Communication Style

1. Always leave screenshots for visual changes.
2. Always leave a detailed description in the Pull Request. Leave nothing ambiguous for the reviewer.
3. Always review your code first. Be sure to run the project locally and test before asking for a review.
4. Always communicate in the GitHub repository. Whether it is in the issue or the pull request, keeping the lines of communication open and visible to everyone on the team helps everyone around you.

## Pull requests

**_We actively welcome your pull requests, however linking your work to an existing issue is preferred._**

1. Fork the repo as [explained here](./Getting-started-guide.md) and create your branch from the default branch.
2. Name your branch something that is descriptive to the work you are doing. i.e. adds-new-thing or fixes-mobile.
3. If you make visual changes, screenshots are required.
4. If you make the existing code better, please let us know in your PR description.
5. A PR description and title are required. The title is required to begin with: "feat:" or "fix:"
6. [Link to an issue](https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls) in the project. Unsolicited code is welcomed, but an issue is required for an announcement your intentions. PR's without a linked issue will be marked invalid and closed.

### PR Titles

Examples for valid PR titles:

- fix: Correct typo.
- feat: Add support for Node 12.
- refactor: Drop support for Node 6.

_Note that since PR titles only have a single line, you have to use the ! syntax for breaking changes._

See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for more examples.

## Issues

If you wish to work on an open issue, please get assign yourself to an issue before beginning work on it to avoid conflicts. For assign an issue to yourself comment on the issue `/attempt #issueNumber` to let us know that you want to work on this issue. Maintainer will check that issue is assigned to anyone else if not then maintainer assigned issue to you.
37 changes: 37 additions & 0 deletions docs/Getting-started-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Getting Started Guide

## Prerequisite

1. Node installed on your machine (For updates in server)
2. Docker installed on your machine (For build image or changes in build process).

## Setup

1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [docker-node-server](https://github.com/Sunny-unik/docker-node-server) to your own GitHub account.
2. Clone the forked repository to your local machine.
3. Create `.env` file and fill environment variables as following written in `.env.example` file.
4. Run `npm i` to install the dependencies and set up the project.

## Development

To run project on your local machine, run:

```shell
npm run dev
```

## Building Image

To build image, run:

```shell
docker build -t <image-name> .
```

## Run Image

To run development server via your image, run:

```shell
docker run -p <container-port>:<your-machine-port> -it <image-name>
```

0 comments on commit eb240db

Please sign in to comment.