Skip to content
This repository was archived by the owner on Mar 21, 2025. It is now read-only.

Commit a57902a

Browse files
Create README.md
1 parent 91c0463 commit a57902a

File tree

1 file changed

+299
-0
lines changed

1 file changed

+299
-0
lines changed

README.md

+299
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,299 @@
1+
<div align="center">
2+
3+
<img src="assets/logo.png" alt="logo" width="200" height="auto" />
4+
<h1>Tech Stack</h1>
5+
6+
<p>
7+
Tech Stack is a collection of packages that I use and maintain either by publishing updates or just security fixes!
8+
</p>
9+
10+
<p>
11+
If you have any suggestions please feel free to add a suggestion issue ticket with a reason why you think it should be added
12+
</p>
13+
14+
15+
<!-- Badges -->
16+
<p>
17+
<a href="https://github.com/The-Code-Monkey/TechStack/graphs/contributors">
18+
<img src="https://img.shields.io/github/contributors/The-Code-Monkey/TechStack" alt="contributors" />
19+
</a>
20+
<a href="">
21+
<img src="https://img.shields.io/github/last-commit/The-Code-Monkey/TechStack" alt="last update" />
22+
</a>
23+
<a href="https://github.com/The-Code-Monkey/TechStack/network/members">
24+
<img src="https://img.shields.io/github/forks/The-Code-Monkey/TechStack" alt="forks" />
25+
</a>
26+
<a href="https://github.com/The-Code-Monkey/TechStack/stargazers">
27+
<img src="https://img.shields.io/github/stars/The-Code-Monkey/TechStack" alt="stars" />
28+
</a>
29+
<a href="https://github.com/The-Code-Monkey/TechStack/issues/">
30+
<img src="https://img.shields.io/github/issues/The-Code-Monkey/TechStack" alt="open issues" />
31+
</a>
32+
<a href="https://github.com/The-Code-Monkey/TechStack/blob/master/LICENSE">
33+
<img src="https://img.shields.io/github/license/The-Code-Monkey/TechStack.svg" alt="license" />
34+
</a>
35+
</p>
36+
37+
<h4>
38+
<a href="https://github.com/The-Code-Monkey/TechStack/">View Demo</a>
39+
<span> · </span>
40+
<a href="https://github.com/The-Code-Monkey/TechStack">Documentation</a>
41+
<span> · </span>
42+
<a href="https://github.com/The-Code-Monkey/TechStack/issues/">Report Bug</a>
43+
<span> · </span>
44+
<a href="https://github.com/The-Code-Monkey/TechStack/issues/">Request Feature</a>
45+
</h4>
46+
</div>
47+
48+
<br />
49+
50+
<!-- Table of Contents -->
51+
# :notebook_with_decorative_cover: Table of Contents
52+
53+
- [About the Project](#star2-about-the-project)
54+
* [Screenshots](#camera-screenshots)
55+
* [Tech Stack](#space_invader-tech-stack)
56+
* [Features](#dart-features)
57+
* [Color Reference](#art-color-reference)
58+
* [Environment Variables](#key-environment-variables)
59+
- [Getting Started](#toolbox-getting-started)
60+
* [Prerequisites](#bangbang-prerequisites)
61+
* [Installation](#gear-installation)
62+
* [Running Tests](#test_tube-running-tests)
63+
* [Run Locally](#running-run-locally)
64+
* [Deployment](#triangular_flag_on_post-deployment)
65+
- [Usage](#eyes-usage)
66+
- [Roadmap](#compass-roadmap)
67+
- [Contributing](#wave-contributing)
68+
* [Code of Conduct](#scroll-code-of-conduct)
69+
- [FAQ](#grey_question-faq)
70+
- [License](#warning-license)
71+
- [Contact](#handshake-contact)
72+
- [Acknowledgements](#gem-acknowledgements)
73+
74+
75+
76+
<!-- About the Project -->
77+
## :star2: About the Project
78+
79+
80+
<!-- Screenshots -->
81+
### :camera: Screenshots
82+
83+
<div align="center">
84+
<img src="https://placehold.co/600x400?text=Your+Screenshot+here" alt="screenshot" />
85+
</div>
86+
87+
88+
<!-- TechStack -->
89+
### :space_invader: Tech Stack
90+
91+
<details>
92+
<summary>Client</summary>
93+
<ul>
94+
<li><a href="https://www.typescriptlang.org/">Typescript</a></li>
95+
<li><a href="https://nextjs.org/">Next.js</a></li>
96+
<li><a href="https://reactjs.org/">React.js</a></li>
97+
<li><a href="https://tailwindcss.com/">TailwindCSS</a></li>
98+
</ul>
99+
</details>
100+
101+
<details>
102+
<summary>Server</summary>
103+
<ul>
104+
<li><a href="https://www.typescriptlang.org/">Typescript</a></li>
105+
<li><a href="https://expressjs.com/">Express.js</a></li>
106+
<li><a href="https://go.dev/">Golang</a></li>
107+
<li><a href="https://nestjs.com/">Nest.js</a></li>
108+
<li><a href="https://socket.io/">SocketIO</a></li>
109+
<li><a href="https://www.prisma.io/">Prisma</a></li>
110+
<li><a href="https://www.apollographql.com/">Apollo</a></li>
111+
<li><a href="https://graphql.org/">GraphQL</a></li>
112+
</ul>
113+
</details>
114+
115+
<details>
116+
<summary>Database</summary>
117+
<ul>
118+
<li><a href="https://www.mysql.com/">MySQL</a></li>
119+
<li><a href="https://www.postgresql.org/">PostgreSQL</a></li>
120+
<li><a href="https://redis.io/">Redis</a></li>
121+
<li><a href="https://neo4j.com/">Neo4j</a></li>
122+
<li><a href="https://www.mongodb.com/">MongoDB</a></li>
123+
</ul>
124+
</details>
125+
126+
<details>
127+
<summary>DevOps</summary>
128+
<ul>
129+
<li><a href="https://www.docker.com/">Docker</a></li>
130+
<li><a href="https://www.jenkins.io/">Jenkins</a></li>
131+
<li><a href="https://circleci.com/">CircleCLI</a></li>
132+
</ul>
133+
</details>
134+
135+
<!-- Features -->
136+
### :dart: Features
137+
138+
- Feature 1
139+
- Feature 2
140+
- Feature 3
141+
142+
<!-- Color Reference -->
143+
### :art: Color Reference
144+
145+
| Color | Hex |
146+
| ----------------- | ------------------------------------------------------------------ |
147+
| Primary Color | ![#222831](https://via.placeholder.com/10/222831?text=+) #222831 |
148+
| Secondary Color | ![#393E46](https://via.placeholder.com/10/393E46?text=+) #393E46 |
149+
| Accent Color | ![#00ADB5](https://via.placeholder.com/10/00ADB5?text=+) #00ADB5 |
150+
| Text Color | ![#EEEEEE](https://via.placeholder.com/10/EEEEEE?text=+) #EEEEEE |
151+
152+
153+
<!-- Env Variables -->
154+
### :key: Environment Variables
155+
156+
To run this project, you will need to add the following environment variables to your .env file
157+
158+
`API_KEY`
159+
160+
`ANOTHER_API_KEY`
161+
162+
<!-- Getting Started -->
163+
## :toolbox: Getting Started
164+
165+
<!-- Prerequisites -->
166+
### :bangbang: Prerequisites
167+
168+
This project uses Yarn as package manager
169+
170+
```bash
171+
npm install --global yarn
172+
```
173+
174+
<!-- Installation -->
175+
### :gear: Installation
176+
177+
Install my-project with npm
178+
179+
```bash
180+
yarn install my-project
181+
cd my-project
182+
```
183+
184+
<!-- Running Tests -->
185+
### :test_tube: Running Tests
186+
187+
To run tests, run the following command
188+
189+
```bash
190+
yarn test
191+
```
192+
193+
<!-- Run Locally -->
194+
### :running: Run Locally
195+
196+
Clone the project
197+
198+
```bash
199+
git clone https://github.com/The-Code-Monkey/TechStack.git
200+
```
201+
202+
Go to the project directory
203+
204+
```bash
205+
cd TechStack
206+
```
207+
208+
Install dependencies
209+
210+
```bash
211+
yarn install
212+
```
213+
214+
Start the server
215+
216+
```bash
217+
yarn start
218+
```
219+
220+
221+
<!-- Deployment -->
222+
### :triangular_flag_on_post: Deployment
223+
224+
To deploy this project run
225+
226+
```bash
227+
yarn deploy
228+
```
229+
230+
231+
<!-- Usage -->
232+
## :eyes: Usage
233+
234+
Use this space to tell a little more about your project and how it can be used. Show additional screenshots, code samples, demos or link to other resources.
235+
236+
237+
```javascript
238+
import Component from 'my-project'
239+
240+
function App() {
241+
return <Component />
242+
}
243+
```
244+
245+
<!-- Roadmap -->
246+
## :compass: Roadmap
247+
248+
* [x] Todo 1
249+
* [ ] Todo 2
250+
251+
252+
<!-- Contributing -->
253+
## :wave: Contributing
254+
255+
<a href="https://github.com/The-Code-Monkey/TechStack/graphs/contributors">
256+
<img src="https://contrib.rocks/image?repo=The-Code-Monkey/TechStack" />
257+
</a>
258+
259+
260+
Contributions are always welcome!
261+
262+
See `contributing.md` for ways to get started.
263+
264+
265+
<!-- Code of Conduct -->
266+
### :scroll: Code of Conduct
267+
268+
Please read the [Code of Conduct](https://github.com/The-Code-Monkey/TechStack/blob/master/CODE_OF_CONDUCT.md)
269+
270+
<!-- FAQ -->
271+
## :grey_question: FAQ
272+
273+
- Question 1
274+
275+
+ Answer 1
276+
277+
- Question 2
278+
279+
+ Answer 2
280+
281+
282+
<!-- License -->
283+
## :warning: License
284+
285+
Distributed under the no License. See LICENSE.txt for more information.
286+
287+
288+
<!-- Contact -->
289+
## :handshake: Contact
290+
291+
Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
292+
293+
Project Link: [https://github.com/The-Code-Monkey/TechStack](https://github.com/The-Code-Monkey/TechStack)
294+
295+
296+
<!-- Acknowledgments -->
297+
## :gem: Acknowledgements
298+
299+
-

0 commit comments

Comments
 (0)