https://github.com/pranav016/gtok
Sample web application on gtok community, developed as a task for an interview.
https://github.com/pranav016/gtok
css firebase html javascript
Last synced: 2 months ago
JSON representation
Sample web application on gtok community, developed as a task for an interview.
- Host: GitHub
- URL: https://github.com/pranav016/gtok
- Owner: Pranav016
- Created: 2021-05-12T15:12:13.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-27T17:43:13.000Z (about 5 years ago)
- Last Synced: 2025-04-10T21:12:44.759Z (about 1 year ago)
- Topics: css, firebase, html, javascript
- Language: HTML
- Homepage:
- Size: 24.4 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gtok
## Demo-
# Environment setup-
* Drop a :star: on the GitHub repository.
* Download [Git](https://git-scm.com/downloads) (when you install Git, Git Bash also gets installed by default)
* Download and install a code/ text editor.
- Recommended-
- [Download VS Code](https://code.visualstudio.com/download)
- [Download Atom](https://atom.io/)
* Download [Node Js and npm(Node package manager)](https://nodejs.org/en/) (when you install Node, npm also gets installed by default)
* This project uses YARN as package manager thus [install YARN](https://classic.yarnpkg.com/en/docs/install/#windows-stable) using npm to run the application.
* Clone the repository by running command
```
git clone https://github.com//gtok.git
```
in your git bash.
* Run command `cd gtok`.
* Run this command to install all dependencies for the project.
```
yarn install
```
* Make account on [Firebase](https://console.firebase.google.com/) and setup a [Firestore database](https://firebase.google.com/docs/firestore/quickstart).
* Add API keys for connecting to the database.
* Run this command when inside the root directory to make a `.env` file.
```
touch .env
```
* Now add your API keys from Firestore to the `.env` file in this format-
```
PORT=3000
HOST=localhost
HOST_URL=http://localhost:3000
API_KEY=
AUTH_DOMAIN=
PROJECT_ID=
STORAGE_BUCKET=
MESSAGING_SENDER_ID=
APP_ID=
SENDER_EMAIL=
SENDER_PASSWORD=
```
* Run this command to start the project.
```
yarn start
```
or
* Run this command to start the project as a developer.
```
yarn run dev
```
* Open link to view the website in your browser window if it doesn't open automatically.
```
http://localhost:3000/
```
* Now you are all set to use this project.