README.md

Build Square

Build Square is a web app made for developers who want to build in public, sharing the change logs of their apps, sharing their finished projects and finding projects to contribute / find contributors, while discovering other developers projects!

MVP features

profile

• profile is created automatically on sign up, assigning the profile a random username
• customize profile
  1. • can edit username
  2. • can edit name
  3. • can edit description
  4. • can edit photo
  5. • can edit wild link
• can delete account
• list user projects on a tab on profile
• list user change logs in a tab on profile

project

• can create a project
  1. • can set cover image (an image for showcasing the project, not as a cover - it must be displayed not as a banner, but as a github readme image)
  2. • can set title
  3. • can set a description.
  4. • can set project homepage link
  5. • can set project github link
• can edit project fields
• can delete project
• can add tags to a project (tags are not created by users, but by the admins)

change log

• can create a change log
  1. • can set a title
  2. • can set description
  3. • can associate it with a project
• can edit change log fields
• can delete change log

feed

• feed view
  1. • can see a feed of profiles, change logs and projects mixed in a masonry layout
• week view
  1. • feed of projects most popular this week
• month view
  1. • feed of popular projects of current month
• year view
  1. • feed of popular projects of current year

search

• can search projects by title
  1. • can filter projects by tags

CONTRIBUTING

The guide for contributing is in CONTRIBUTING.md