Skip to content

Commit 5513bfb

Browse files
authored
Update README.md
A simple README to execute the project
1 parent bc21578 commit 5513bfb

1 file changed

Lines changed: 12 additions & 21 deletions

File tree

README.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,15 @@
1-
# README
1+
# SearchBox Project
22

3-
This README would normally document whatever steps are necessary to get the
4-
application up and running.
3+
In this project, where we used Turbo, SQL and Stimulus, we can search for articles with a real time search mechanism.
54

6-
Things you may want to cover:
5+
With a analytic view, we can see some information for your top articles search and all of your own history of search.
6+
Also, we can see the trending articles what are being searched.
77

8-
* Ruby version
9-
10-
* System dependencies
11-
12-
* Configuration
13-
14-
* Database creation
15-
16-
* Database initialization
17-
18-
* How to run the test suite
19-
20-
* Services (job queues, cache servers, search engines, etc.)
21-
22-
* Deployment instructions
23-
24-
* ...
8+
## How to install?
9+
Start cloning the project to a folder and then, do the following commands:
10+
```bash
11+
> bundle install
12+
> bundle exec rails db:create db:migrate db:seed
13+
> bin/dev
14+
```
15+
Access it on `http://localhost:3000`

0 commit comments

Comments
 (0)