Skip to content

README.md

Latest commit

 

History

History
58 lines (33 loc) · 1.65 KB

README.md

File metadata and controls

58 lines (33 loc) · 1.65 KB

cribsandspaces

Build Status

Netlify Status

📚 An interior Design company website built with React using TailwindCSS + GraphQL

Prerequisites

Kindly ensure you install the following softwares

  1. Git
  2. Node.js
  3. Node Package Manager (npm), this comes pre-installed with Node.js

Getting Started

In order to get a copy of the project up and running on your local computer for development and testing purposes. Do the following

  1. Clone the repo.
  2. Switch to project directory
  3. Type npm install to install dependencies
  4. Type npm run dev to start development server

To certify that the server is operational navigate to http://localhost:3500 on your browser.

Todo

Cribs and Spaces Workflow

  • Git Workflow

    See link to version control convention and usage

  • Git Workflow

  • Implement the chores listed below

    Integrate TDD using jest and RTL
Integrate CI/CD via Travis CI and Netlify
Integrate Test Coverage (Code climate and Coveralls)
Integrate pre-commit hooks (Prettier, ESLint) & Airbnb Style Guide

  • Refactoring components in the pages folder

    Curate components into the atomic design workflow

  • Contributors

    • @devPinheiro
    • @estheritolima