imjord/rust_readme_generator

Readme Generator for your projects made in rust

RUST READ ME GENERATOR!!!

mern readme made in rust

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

A readme generator that i originally made in node. rewritten in rust. a readme for mern projects.

(back to top)

Built With

Rust of course

(back to top)

Getting Started

If you would like to clone the repo hopefully this will help.

Prerequisites

for mern projects

Installation

1. Clone the repo

   git clone https://github.com/imjord/rust_readme_generator.git

2. Install NPM packages in both client and server folders

   npm install

3. Create a .env file in the server folder and add your own MongoDB URI

   MONGODB_URI=YOUR_OWN_MONGODB_URI

4. Run the start commands in both client and server folders (commands are in the package.json files).

   npm start / npm run dev

5. Enjoy! made with <3 by imjord

(back to top)

Usage

NA

(back to top)

Roadmap

• [] more rust

See the open issues for a full list of future proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

(back to top)

License

MIT

(back to top)

Contact

Just message me on github mang <3 imjord

Project Link: https://github.com/imjord/rust_readme_generator

(back to top)