Skip to content

Commit 45ab5a8

Browse files
Update README.md
1 parent 5670fed commit 45ab5a8

File tree

1 file changed

+31
-13
lines changed

1 file changed

+31
-13
lines changed

README.md

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,38 @@
1-
# andronix-website-base
1+
<p align="center">
2+
<img width="500" height="250" src="https://i.ibb.co/85hpwFx/readme-logo.png" alt="andronix-internal-api">
3+
</p>
24

3-
## Build Setup
5+
<p align="center">
6+
<a href=""><img src="https://github.com/imprakharshukla/andronix-website-base/workflows/Chrome%20E2E%20CI/badge.svg?branch=dev"></a>
7+
<a href=""><img src="https://github.com/imprakharshukla/andronix-website-base/workflows/Production%20Deploy/badge.svg?branch=master"></a>
8+
<a href=""><img src="https://github.com/imprakharshukla/andronix-website-base/workflows/Dev%20Deploy/badge.svg?branch=dev&event=push"></a>
9+
</p>
410

5-
```bash
6-
# install dependencies
7-
$ npm install
11+
## What is this? ⚡
12+
This is the repository of the official website for [Andronix App](https://git.andronix.app). This combines billing for the digital products that Andronix offers and Andronix Commands.
813

9-
# serve with hot reload at localhost:3000
10-
$ npm run dev
14+
> Andronix Commands will be added soon to this repo. It currently resides on [here](https://web.andronix.app) and is build with just VueJS and Tailwind.
1115
12-
# build for production and launch server
13-
$ npm run build
14-
$ npm run start
16+
## What is the Tech-Stack? 📐
1517

16-
# generate static project
17-
$ npm run generate
18+
This website/web-app is built using [NuxtJS](https://nuxtjs.org) and [Tailwind](https://tailwindcss.com). Deployed on [Netlify](https://netlify.com) and uses [GitHub Actions](https://github.com/features/actions) for the app pipeline.
19+
20+
### - Testing 🤖
21+
We use [Cypress](https://cypress.io) for our E2E automated tests. Our unit and integration tests are done through [Mocha](https://mochajs.org) and [Chai](https://www.chaijs.com).
22+
23+
## Developer Notes
24+
25+
### How to run it locally? 🏠
26+
Clone the project and assuming that you have NodeJS installed on your machine already, run -
27+
``` bash
28+
# yarn
29+
yarn run dev # for the development server.
30+
yarn run generate # for the production build.
31+
32+
# npm
33+
npm run dev # for the development server.
34+
npm run generate # for the production build.
1835
```
1936

20-
For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
37+
### How do I contribute? 🏗
38+
If you want to improve something or maybe add something new, you can just send a pull request and if that's something that we would like to add/change, we'll be more than happy to merge it.

0 commit comments

Comments
 (0)