Skip to content

Commit

Permalink
Merge pull request #16 from Alkaison/migrate-to-react
Browse files Browse the repository at this point in the history
feat: migrated whole appliaction to react.js and firebase
  • Loading branch information
Alkaison authored Dec 9, 2023
2 parents e76a1ab + 40df12d commit e9beae4
Show file tree
Hide file tree
Showing 43 changed files with 19,879 additions and 1,404 deletions.
23 changes: 22 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,22 @@
firebase/config.js
# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build
.env

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Live Clipboard

![Live Clipboard](https://github.com/Alkaison/Live-Clipboard/assets/98116504/7b376fc1-ca5f-460a-aca5-f6cf1b263cf0)
![Live Clipboard](https://github.com/Alkaison/Live-Clipboard/assets/98116504/91fd6f21-d09b-47ff-8b02-d565ad26f4eb)

Welcome to Live Clipboard, an exciting open-source project! We're thrilled to have you join us on this journey to create a web app using Firebase Realtime Database.

Expand All @@ -15,8 +15,8 @@ Live Clipboard is a web app that allows users to create, edit, and collaborate o

### Technologies Used:

![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
![Firebase](https://img.shields.io/badge/firebase-ffca28?style=for-the-badge&logo=firebase&logoColor=black)
![JavaScript](https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E)
![Netlify](https://img.shields.io/badge/Netlify-00C7B7?style=for-the-badge&logo=netlify&logoColor=black)

## Why Contribute?
Expand All @@ -43,7 +43,7 @@ git clone https://github.com/Alkaison/Live-Clipboard.git

3. **Set Up Firebase**: If you haven't already, create a Firebase project and set up the Firebase Realtime Database. You can follow Firebase's [official documentation](https://firebase.google.com/docs/database) for guidance.

4. **Firebase Setup**: Rename the `firebase/config.example.js` to `firebase/config.js` and add your Firebase Realtime Database API Credentials into the `firebaseConfig`.
4. **Package Installation**: Install packages by running this command `npm install` and then create `.env` file and add your Firebase app keys in it.

5. **Development**: Start contributing by working on issues, adding new features, or fixing bugs. Be sure to create a new branch for your work:

Expand All @@ -67,12 +67,11 @@ To maintain a healthy and collaborative open-source community, please adhere to

## Project Structure

The project structure is organized as follows:
The project structure under `src` is organized as follows:

- `/assets`: Project images and favicons.
- `/css`: Website StyleSheets.
- `/js`: Vanilla JavaScript code files.
- `/firebase`: Firebase configuration files.
- `components/`: contains all components for the pages.
- `firebase/`: contains Firebase config file.
- `pages/`: contains pages container.

## Contact

Expand Down
152 changes: 0 additions & 152 deletions about.html

This file was deleted.

Loading

0 comments on commit e9beae4

Please sign in to comment.