|
1 | | -# Generic Project Template |
| 1 | +<p align="center"><img src="./docs/assets/img/logo/noclocks-logo-white.svg" height="50%" width="50%" /></p> |
| 2 | +<p align="center"> |
| 3 | + <a href="https://noclocks.dev">Website</a> | |
| 4 | + <a href="https://blog.noclocks.dev">Blog</a> | |
| 5 | + <a href="https://docs.noclocks.dev">Documentation</a> | |
| 6 | + <a href="https://cal.com/team/noclocks">Contact/Schedule</a> | |
| 7 | + <a href="https://github.com/sponsors/noclocks">Sponsor</a> |
| 8 | +</p> |
| 9 | +<p align="center">No Clocks, LLC Website (https://noclocks.dev) built using React, TypeScript, and ...</p> |
| 10 | +<p align="center"> |
| 11 | + <img src="https://github.com/noclocks/.github/assets/32652297/6af2998d-ae34-4aaf-b0db-e8d1cf2217bd" width="15%" /> |
| 12 | +</p> |
| 13 | + |
| 14 | +# No Clocks, LLC Website |
2 | 15 |
|
3 | 16 | > [!NOTE] |
4 | | -> This is a generic project template that can be used as a starting point for any project. |
| 17 | +> [No Clocks, LLC](https://github.com/noclocks) is a new, cutting-edge, technology-based agency startup that seamlessly blends the expertise of seasoned Software Engineers, Web Developers, Data Engineers. |
5 | 18 |
|
6 | 19 | ## Contents |
7 | 20 |
|
8 | | -- [Generic Project Template](#generic-project-template) |
9 | | - - [Contents](#contents) |
10 | | - - [Introduction](#introduction) |
| 21 | +- [Overview](#overview) |
| 22 | +- [Repository](#repository) |
11 | 23 | - [Project Structure](#project-structure) |
12 | | - - [Contributing](#contributing) |
13 | | - - [License](#license) |
| 24 | +- [Features](#features) |
| 25 | +- [Technologies](#technologies) |
| 26 | + - [Tech Stack](#tech-stack) |
| 27 | +- [Getting Started](#getting-started) |
| 28 | + - [Installation](#installation) |
| 29 | + - [Environment](#environment) |
| 30 | + - [Deployment](#deployment) |
| 31 | +- [Contributing](#contributing) |
| 32 | +- [License](#license) |
14 | 33 |
|
15 | | -## Introduction |
16 | 34 |
|
17 | | -This is a generic project template that can be used as a starting point for any project. |
| 35 | +## Overview |
18 | 36 |
|
19 | | -It includes a basic project structure and default files that can be used to start a new project. |
| 37 | +[No Clocks, LLC](https://github.com/noclocks) is an avant-garde technology-based agency that brings together a dynamic team of Software Engineers, Web Developers, and Data Engineers. We thrive on innovation and our proficiency spans a multitude of programming languages and frameworks, making us a formidable force in technology consulting and development across various industries. |
| 38 | + |
| 39 | +## Repository |
| 40 | + |
| 41 | +This repository houses the codebase for our official website hosted at <https://noclocks.dev>. |
| 42 | + |
| 43 | +It serves as a digital showcase of our expertise and the services we offer, reflecting our commitment to excellence and our journey towards becoming an engineering powerhouse. |
| 44 | + |
| 45 | +### Project Structure |
| 46 | + |
| 47 | +`#TODO` |
| 48 | + |
| 49 | +## Features |
| 50 | + |
| 51 | +- **Dynamic Web Presence**: Our website is designed to be responsive, engaging, and informative, providing an in-depth look at our services and the unique value we bring to our clients. |
| 52 | +- **Interactive API**: We use a custom-built API for dynamic content delivery and integration with backend services. |
| 53 | +- **Database Integration**: Ensuring smooth data flow and security with our robust database administration. |
| 54 | +- **Infrastructure as Code (IaC)**: Leveraging modern DevOps practices to streamline and automate our cloud infrastructure. |
| 55 | + |
| 56 | +## Technologies |
| 57 | + |
| 58 | +This project is built using a mix of cutting-edge technologies that include: |
| 59 | + |
| 60 | +- **Modern Frontend Frameworks**: |
| 61 | +- **Backend Technologies**: |
| 62 | +- **Cloud Hosted Services**: |
| 63 | +- **Database and Content Management**: |
| 64 | +- **Third-Party API Integrations**: |
| 65 | +- **Artificial Intelligence Tooling**: |
| 66 | + |
| 67 | +### Tech-Stack |
| 68 | + |
| 69 | +- [Node.js]() | [Bun.js]() |
| 70 | +- [React.js]() |
| 71 | +- [TypeScript]() | [JavaScript]() |
| 72 | +- [Vite.js]() |
| 73 | +- [Vercel]() |
| 74 | +- [Google Cloud Platform]() |
| 75 | +- [Docker]() |
| 76 | + |
| 77 | +## Getting Started |
| 78 | + |
| 79 | +### Installation |
| 80 | + |
| 81 | +To get started with the repository locally, first clone and install the repository: |
| 82 | + |
| 83 | +```bash |
| 84 | +git clone https://github.com/noclocks/noclocks.dev |
| 85 | +cd noclocks.dev |
| 86 | +bun install |
| 87 | +``` |
| 88 | + |
| 89 | +if you prefer to use `npm`, `yarn`, or `pnpm`, replace `bun` with the preference package manager. |
| 90 | + |
| 91 | +### Environment |
| 92 | + |
| 93 | +Next, setup your local environment variables: |
| 94 | + |
| 95 | +```bash |
| 96 | +cp .env.example .env |
| 97 | +``` |
| 98 | + |
| 99 | +and populate `.env`: |
| 100 | + |
| 101 | +`#TODO` |
| 102 | + |
| 103 | +```plaintext |
| 104 | +... |
| 105 | +``` |
| 106 | + |
| 107 | +### Technical Documentation |
| 108 | + |
| 109 | +`#TODO` |
| 110 | + |
| 111 | +### Testing |
| 112 | + |
| 113 | +`#TODO` |
| 114 | + |
| 115 | +### Deployment |
| 116 | + |
| 117 | +`#TODO` |
| 118 | + |
| 119 | +*** |
20 | 120 |
|
21 | 121 | ## Root Files |
22 | 122 |
|
|
0 commit comments