https://github.com/forloop94/island_constructor

https://github.com/forloop94/island_constructor

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/forloop94/island_constructor
• Owner: forLoop94
• License: mit
• Created: 2024-01-22T17:56:20.000Z (over 2 years ago)
• Default Branch: dev
• Last Pushed: 2025-01-04T12:40:46.000Z (over 1 year ago)
• Last Synced: 2025-01-04T13:44:31.444Z (over 1 year ago)
• Language: JavaScript
• Size: 1.36 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          




  
Seyi & Co



# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 Budget App ](#-budget-app-)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

  - [💻 Getting Started ](#-getting-started-)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Usage](#usage)

    - [Run tests](#run-tests)

  - [🚀 Deployment ](#-deployment-)

  - [🎞️ Presentation Video ](#️-presentation-video-)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 📖 Budget App 

The **Seyi & Co**  is a website for a construction company. The pages have placeholder text and images for now.

## 🛠 Built With 

### Tech Stack 

- React

- CSS

- HTML

- Bootstrap

### Key Features 

- [ ] **Projects**

- [ ] **News**

- [ ] **Footer**

- [ ] **About**

- [ ] **Home**

(back to top)


## 💻 Getting Started 

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

- A computer or mobile device

- Node.js

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git@github.com:forLoop94/Island_constructor.git

  npm install

```

### Usage

To run the project, execute the following command:

```sh

  npm run dev

```

### Run tests

To run tests, run the following commands:

```sh

 npx eslint "**/*.{js,jsx}"

 npx stylelint "**/*.{css,scss}"

```

(back to top)


## 🚀 Deployment 

Deployment: [live demo](https://seyi-construction.netlify.app/)

(back to top)


(back to top)


## 👥 Authors 

👤 **Charles Andrews**

- GitHub: [@githubhandle](https://github.com/forLoop94)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/andrewsCharlesUwem/)

(back to top)


## 🔭 Future Features 

- **Board of Directors page**

- **Careers page**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/forLoop94/Island_constructor/issues).

(back to top)


## ⭐️ Show your support 

If you like this project give me a follow and/or a star

(back to top)


## 🙏 Acknowledgments 

I would like to thank Seyi & CO for the great opportunity to work on this project

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)