Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ACE-VSIT/website

ACE Website 2022 - (Monorepo and Mico-Frontend ) Admin Panel: https://admin.vipsace.org/
https://github.com/ACE-VSIT/website

axios context-api custom-hooks firebase firestore-database gatsby gcp graphql javascript lottie-animation monorepo nx prismic react-spring react-table serverless-functions styled-components typescript zustand

Last synced: about 3 hours ago
JSON representation

ACE Website 2022 - (Monorepo and Mico-Frontend ) Admin Panel: https://admin.vipsace.org/

Awesome Lists containing this project

README

        



ace-vips



ACE Website Development Guide

Hello reader, our team has initiated this project in order to update the ACE's website and along with that this can be a great opportunity for all of the team members to learn and explore various technologies which are used on the Web.

This guide includes everything you need to get started with the Project.

Wish you luck!

_If you find anything which can be improved in the README.md then ping [me](https://github.com/nparashar150/) and give a pull request._

## 🚀 Quick start

1. **Download required softwares.**

1. Download Github from [here](https://git-scm.com/downloads)
2. Download Node.js from [here](https://nodejs.org/en/download/)
3. Download your favourite Code Editor (VS Code Preferred)

1. **Setup Environment locally.**

1. Clone Repo & Install dependencies

_Linux / Mac Users_

1. Run the following commands in your terminal

```shell
cd ~/Desktop
git clone https://github.com/ACE-VSIT/website
cd ./website
yarn
cd packages/website && touch .env.development
cd packages/admintable && touch .env
```

_Windows Users_

1. Open CMD / Power Shell / Git Bash in your folder
2. Run the following commands

```shell
git clone https://github.com/ACE-VSIT/website
cd ./website
yarn
create .env.development inside packages/website
create .env inside packages/admintable
```

2. Open the Project in your preferred code editor
3. Opne the .env.development file of each package and add the required env-vars
4. Start the Local Dev server

Note\* the server takes some time to start.

```shell
yarn start
```

5. Website should be up and running on your `http://localhost:8000/`
6. Admintable should be up and runnning on your `http://localhost:3000/`

## [:man_technologist: Directory Structure](https://github.com/ACE-VSIT/ACE-Website/blob/main/DIRECTORY.md)