feat: Add gitignore template
This commit is contained in:
commit
00424ea4c1
10 changed files with 1053 additions and 0 deletions
89
README.md
Normal file
89
README.md
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
# [Project Title]
|
||||
|
||||
> [One-line description of what this project does.]
|
||||
|
||||
[](https://gitlab.com/rideaware/[repo-name]/-/pipelines)
|
||||
[](https://www.gnu.org/licenses/agpl-3.0)
|
||||
|
||||
<!-- TABLE OF CONTENTS -->
|
||||
<details>
|
||||
<summary>Table of Contents</summary>
|
||||
<ol>
|
||||
<li><a href="#about-the-project">About The Project</a></li>
|
||||
<li><a href="#getting-started">Getting Started</a></li>
|
||||
<li><a href="#usage">Usage</a></li>
|
||||
<li><a href="#contributing">Contributing</a></li>
|
||||
<li><a href="#license">License</a></li>
|
||||
<li><a href="#contact">Contact</a></li>
|
||||
</ol>
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## About The Project
|
||||
|
||||
<!-- In this section, provide a more detailed overview of the project. -->
|
||||
<!-- What problem does it solve? What are its key features? -->
|
||||
<!-- You can also include screenshots or diagrams here if applicable. -->
|
||||
|
||||
Built With:
|
||||
<!-- List the major frameworks/libraries used in your project. -->
|
||||
* [React.js](https://reactjs.org/)
|
||||
* [Node.js](https://nodejs.org/)
|
||||
* [Python](https://www.python.org/)
|
||||
|
||||
## Getting Started
|
||||
|
||||
Follow these instructions to get a copy of the project up and running on your
|
||||
local machine for development and testing purposes.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
<!-- List any software or tools that need to be installed beforehand. -->
|
||||
* npm
|
||||
```sh
|
||||
npm install npm@latest -g
|
||||
```
|
||||
|
||||
### Installation
|
||||
|
||||
1. Clone the repo
|
||||
```sh
|
||||
git clone https://gitlab.com/rideaware/[repo-name].git
|
||||
```
|
||||
2. Install NPM packages
|
||||
```sh
|
||||
npm install
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
<!-- Provide code examples and instructions on how to use your project. -->
|
||||
<!-- For a library, show how to import and use its functions. -->
|
||||
<!-- For an application, explain how to run it and what the main features are. -->
|
||||
|
||||
```javascript
|
||||
import { awesomeFeature } from "rideaware-project";
|
||||
|
||||
const result = awesomeFeature();
|
||||
console.log(result);
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are what make the open-source community such an amazing place to
|
||||
learn, inspire, and create. Any contributions you make are **greatly
|
||||
appreciated**.
|
||||
|
||||
Please read our [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of
|
||||
conduct, and the process for submitting merge requests to us.
|
||||
|
||||
## License
|
||||
|
||||
Distributed under the GNU AGPLv3 License. See `LICENSE` for more information.
|
||||
|
||||
## Contact
|
||||
|
||||
Blake - blake@rideaware.org
|
||||
|
||||
Project Link: [https://gitlab.com/rideaware/[repo-name]](https://gitlab.com/rideaware/[repo-name])
|
||||
Loading…
Add table
Add a link
Reference in a new issue