Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sashenjayathilaka/google-docs
Google Docs with REACT.JS! (Next.js, Rich Text Editor, Tailwind CSS & Firebase)
https://github.com/sashenjayathilaka/google-docs
draft-js firebase-auth firestore javascript mui mui-icons nextjs react react-draft-wysiwyg react-firebase-hooks tailwind-css vercel-deployment
Last synced: about 1 month ago
JSON representation
Google Docs with REACT.JS! (Next.js, Rich Text Editor, Tailwind CSS & Firebase)
- Host: GitHub
- URL: https://github.com/sashenjayathilaka/google-docs
- Owner: SashenJayathilaka
- Created: 2022-09-26T04:01:53.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-09-26T04:32:45.000Z (over 2 years ago)
- Last Synced: 2024-12-26T19:21:13.242Z (about 1 month ago)
- Topics: draft-js, firebase-auth, firestore, javascript, mui, mui-icons, nextjs, react, react-draft-wysiwyg, react-firebase-hooks, tailwind-css, vercel-deployment
- Language: JavaScript
- Homepage: https://google-doc-eight.vercel.app
- Size: 128 KB
- Stars: 41
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Google Docs with REACT.JS!
### :camera: Screenshots
## LIVE DEMO 💥
### :space_invader: Tech Stack
Client
Database
## :toolbox: Getting Started
### :bangbang: Prerequisites
- Sign up for a Firebase account HERE
- Install Node JS in your computer HERE
### :key: Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`NEXT_PUBLIC_FIREBASE_API_KEY`
`NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN`
`NEXT_PUBLIC_FIREBASE_PROJECT_ID`
`NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET`
`NEXT_PUBLIC_FIREBASE_MESSAGING_SET`
`NEXT_PUBLIC_FIREBASE_APP_ID`
`NEXT_PUBLIC_BASE_URL`
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
### :gear: Installation
Install my-project with npm
```
npx create-next-app my-project
```
```
cd my-project
```
Install dependencies
### :test_tube: Install Tailwind CSS with Next.js
#### Install Tailwind CSS
Install tailwindcss and its peer dependencies via npm, and then run the init command to generate both `tailwind.config.js` and `postcss.config.js`.
```
npm install -D tailwindcss postcss autoprefixer
```
```
npx tailwindcss init -p
```
#### Configure your template paths
Add the paths to all of your template files in your `tailwind.config.js` file.
```
module.exports = {
content: [
"./pages/**/*.{js,ts,jsx,tsx}",
"./components/**/*.{js,ts,jsx,tsx}",
],
theme: {
extend: {},
},
plugins: [],
}
```
#### Add the Tailwind directives to your CSS
Add the `@tailwind` directives for each of Tailwind’s layers to your `./styles/globals.css` file.
```
@tailwind base;
@tailwind components;
@tailwind utilities;
```
Install dependencies
### :running: Run Locally
Clone the project
```bash
git clone https://github.com/SashenJayathilaka/Google-Docs.git
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run dev
```
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
### Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
### :triangular_flag_on_post: Deployment
To deploy this project run
##### Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
## :handshake: Contact
Sashen - [@twitter_handle](https://twitter.com/SashenHasinduJ) - [email protected]
Project Link: [https://github.com/SashenJayathilaka/Google-Docs.git](https://github.com/SashenJayathilaka/Google-Docs.git)