Skip to content

Commit

Permalink
Add project instructions to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kwizl committed Jun 1, 2020
1 parent 34db2d3 commit 5e61888
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 9 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Scaffold for social media app with Ruby on Rails

> This repo includes intial code for social media app with basic styling. Its purpose is to be a starting point for Microverse students.
> This project consists of a basic Social Media App. The features of the project include signing up as a user and sending friend request to other users. The other users can accept or reject the friend request. On the timeline page, only the posts belonging to the signed in user and his/her firends can be viewed.
## Built With

Expand All @@ -11,7 +11,6 @@

TBA


## Getting Started

To get a local copy up and running follow these simple example steps.
Expand All @@ -24,7 +23,9 @@ Postgres: >=9.5

### Setup

Instal gems with:
Clone the repo

Install gems with:

```
bundle install
Expand Down Expand Up @@ -55,15 +56,25 @@ Open `http://localhost:3000/` in your browser.
rpsec --format documentation
```

> Tests will be added by Microverse students. There are no tests for initial features in order to make sure that students write all tests from scratch.
> All tests are contained in the rspec folder which is in the root directory of the project. To run all test type **rspec** in the terminal. To run a specific test type **rspec spec/folder_name/spec_file.rb**
### Deployment

TBA

## Authors

TBA
👤 **Martin Njoroge**

- Github: [@kwizl](https://github.com/kwizl)
- Twitter: [@NjoroKaris](https://twitter.com/NjoroKaris)
- Linkedin: [martin njoroge](https://www.linkedin.com/in/martin-njoroge-098774110/)

👤 **Abdel Omar Pérez Téllez**

- Github: [abdelp](https://github.com/abdelp)
- Twitter: [@abdelperez11](https://twitter.com/abdelperez11)
- Linkedin: [abdel-perez](https://www.linkedin.com/in/abdel-perez/)

## 🤝 Contributing

Expand Down
4 changes: 2 additions & 2 deletions db/seeds.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
# movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
# Character.create(name: 'Luke', movie: movies.first)

User.create!(name: "Abdel Pérez", email: "juniorperezpy@gmail.com",
User.create!(name: "Abdel Pérez", email: "perezpy@gmail.com",
password: "123456", password_confirmation: "123456")

User.create!(name: "Martin Njoroge", email: "[email protected]",
password: "123456", password_confirmation: "123456")

User.create!(name: "Susan Cho", email: "example@railsgirls.com",
User.create!(name: "Susan Cho", email: "examp@girls.com",
password: "123456", password_confirmation: "123456")

User.create!(name: "Ivan Diaz", email: "[email protected]",
Expand Down
4 changes: 2 additions & 2 deletions spec/factories/users.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
FactoryBot.define do
factory :user do
sequence(:name, 10) { |n| "User#{n}" }
sequence(:email, 10) { |n| "person#{n}@example.com" }
sequence(:name, 20) { |n| "User#{n}" }
sequence(:email, 20) { |n| "person#{n}@example.com" }
password { '123456' }
password_confirmation { '123456' }
end
Expand Down

0 comments on commit 5e61888

Please sign in to comment.