Skip to content

Commit c8720b1

Browse files
committed
Update readme file
1 parent 9056dc1 commit c8720b1

File tree

1 file changed

+28
-83
lines changed

1 file changed

+28
-83
lines changed

README.md

Lines changed: 28 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
[![Product Name Screen Shot][product-screenshot]](https://reporter73.000webhostapp.com/)
88

9+
<br>
910
Welcome to Reporter, a new article writing website dedicated to providing high-quality content for businesses and individuals.
1011

1112
In addition to our writing services, we also offer editing and proofreading services to ensure that your content is error-free and meets the highest standards of quality.
@@ -30,113 +31,57 @@ This section should list any major frameworks/libraries used to bootstrap your p
3031

3132
## Getting Started
3233

33-
This is an example of how you may give instructions on setting up your project locally.
34-
To get a local copy up and running follow these simple example steps.
34+
Clone the repository and run the following commands to get started.
3535

36-
### Prerequisites
36+
```
37+
git clone https://github.com/TheAlter71/Reporter.git
38+
```
3739

38-
This is an example of how to list things you need to use the software and how to install them.
39-
40-
- npm
41-
```sh
42-
npm install npm@latest -g
43-
```
40+
I hope that you already have PHP, Laravel, Node, Composer and MySQL installed on your computer. If not, please install them first.
41+
</br>
42+
</br>
4443

4544
### Installation
4645

47-
_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
48-
49-
1. Get a free API Key at [https://example.com](https://example.com)
50-
2. Clone the repo
51-
```sh
52-
git clone https://github.com/your_username_/Project-Name.git
53-
```
54-
3. Install NPM packages
55-
```sh
56-
npm install
57-
```
58-
4. Enter your API in `config.js`
59-
```js
60-
const API_KEY = "ENTER YOUR API";
61-
```
62-
63-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
64-
65-
<!-- USAGE EXAMPLES -->
66-
67-
## Usage
68-
69-
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
70-
71-
_For more examples, please refer to the [Documentation](https://example.com)_
72-
73-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
74-
75-
<!-- ROADMAP -->
76-
77-
## Roadmap
46+
_Now you have to setup your .env file with necessary informations. If you are good at laravel development then its very easy to you._
7847

79-
- [x] Add Changelog
80-
- [x] Add back to top links
81-
- [ ] Add Additional Templates w/ Examples
82-
- [ ] Add "components" document to easily copy & paste sections of the readme
83-
- [ ] Multi-language Support
84-
- [ ] Chinese
85-
- [ ] Spanish
48+
1. Generate new key for the project
8649

87-
See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).
50+
```sh
51+
php artisan key:generate
52+
```
8853

89-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
90-
91-
<!-- CONTRIBUTING -->
54+
2. Update the composer
9255

93-
## Contributing
56+
```sh
57+
composer update
58+
```
9459

95-
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
60+
3. Migrate the database
9661

97-
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".
98-
Don't forget to give the project a star! Thanks again!
62+
```sh
63+
php artisan migrate:fresh
64+
```
9965

100-
1. Fork the Project
101-
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
102-
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
103-
4. Push to the Branch (`git push origin feature/AmazingFeature`)
104-
5. Open a Pull Request
66+
4. Run application locally
10567

106-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
68+
```sh
69+
php artisan serve
70+
```
10771

10872
<!-- LICENSE -->
10973

11074
## License
11175

112-
Distributed under the MIT License. See `LICENSE.txt` for more information.
113-
114-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
76+
Distributed under the MIT License. See `LICENSE` for more information.
11577

11678
<!-- CONTACT -->
11779

11880
## Contact
11981

120-
Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com
121-
122-
Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
123-
124-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
125-
126-
<!-- ACKNOWLEDGMENTS -->
127-
128-
## Acknowledgments
129-
130-
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
82+
Your Name - [@TheAlter72](https://twitter.com/TheAlter72) - hello.mehedi@outlook.com
13183

132-
- [Choose an Open Source License](https://choosealicense.com)
133-
- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
134-
- [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
135-
- [Malven's Grid Cheatsheet](https://grid.malven.co/)
136-
- [Img Shields](https://shields.io)
137-
- [GitHub Pages](https://pages.github.com)
138-
- [Font Awesome](https://fontawesome.com)
139-
- [React Icons](https://react-icons.github.io/react-icons/search)
84+
Project Link: [https://reporter73.000webhostapp.com](https://reporter73.000webhostapp.com)
14085

14186
<p align="right">(<a href="#readme-top">back to top</a>)</p>
14287

0 commit comments

Comments
 (0)