Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert "Setup google and github authentication" #27

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 7 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,90 +25,58 @@ The `voyage-tasks` project is developed by a collaborative team within the Ching

For more insights into writing a great README, refer to this article by an experienced Chingu member: [Keys to a well-written README](https://tinyurl.com/yk3wubft).

### How to Run the Application

### How to Run the Application
---

Follow these steps to set up and run the application locally:

1. **Install Dependencies**

First, install the required dependencies by running:

```bash
npm install
```

2. **Run Docker Compose**

Ensure Docker is installed and running on your machine. Navigate to the root of the project directory and execute:

```bash
docker-compose up -d
```

This command will start a PostgreSQL database as defined in `docker-compose.yml` with persistent storage, ensuring data retention across restarts.

3. **Set Up Environment Variables**

In the root directory, create a `.env` file with the following content:

```env
DATABASE_URL="postgresql://docker:docker@localhost:5432/apisippy"
```

Ensure that `DATABASE_URL` matches the credentials and database settings configured in `docker-compose.yml`.

4. **Generate Prisma Client**

To generate the Prisma client based on the defined schema, run:

```bash
npm run prisma:generate
```

5. **Run Prisma Migrations**

Apply migrations to the PostgreSQL database to set up the initial schema:

```bash
npm run prisma:migrate
```

This command will create tables and relationships as specified in `prisma/schema.prisma`.

6. **Start the Development Server**

Finally, start the Next.js development server:

```bash
npm run dev
```

The application should now be running locally. Visit [http://localhost:3000](http://localhost:3000) to view the project in your browser.

| Meeting Agenda Templates | Link |
| ---------------------------------------------------- | -------------------------------------------------------------------- |
| Meeting - Voyage Kickoff | [link](./docs/meeting-voyage_kickoff.docx) |
| Meeting - App Vision & Feature Planning | [link](./docs/meeting-vision_and_feature_planning.docx) |
| Meeting - Sprint Retrospective, Review, and Planning | [link](./docs/meeting-sprint_retrospective_review_and_planning.docx) |
| Meeting - Sprint Open Topic Session | [link](./docs/meeting-sprint_open_topic_session.docx) |

## oAuth

### Google

1. Sign up for Google Cloud and navigate to your console https://console.cloud.google.com/
2. Create an oAuth consent screen
3. The Callback url for dev is `http://localhost:3000/api/auth/callback/google`
4. Copy your Google clientID and secret to the `.env`

### Github

1. Sign up for Github oAuth in Settings / Developer Settings
2. Enter relavent app details
3. The Callback url for dev is `http://localhost:3000/api/auth/callback/github`
4. Generate a secret and copy and paste ID and secret to appropriate `.env` variable

## Environment Setup

Expand Down Expand Up @@ -139,12 +107,12 @@ To facilitate team collaboration, use these documents available in the `/docs` d

### Meeting Agenda Templates

| Meeting Agenda Templates | Link |
| ------------------------------------------ | -------------------------------------------------------------------- |
| Voyage Kickoff | [Link](./docs/meeting-voyage_kickoff.docx) |
| App Vision & Feature Planning | [Link](./docs/meeting-vision_and_feature_planning.docx) |
| Sprint Retrospective, Review, and Planning | [Link](./docs/meeting-sprint_retrospective_review_and_planning.docx) |
| Sprint Open Topic Session | [Link](./docs/meeting-sprint_open_topic_session.docx) |
| Meeting Agenda Templates | Link |
| ---------------------------------------------------- | ----------------------------------------------------------------- |
| Voyage Kickoff | [Link](./docs/meeting-voyage_kickoff.docx) |
| App Vision & Feature Planning | [Link](./docs/meeting-vision_and_feature_planning.docx) |
| Sprint Retrospective, Review, and Planning | [Link](./docs/meeting-sprint_retrospective_review_and_planning.docx) |
| Sprint Open Topic Session | [Link](./docs/meeting-sprint_open_topic_session.docx) |

---

Expand All @@ -167,15 +135,6 @@ This project is built and maintained as part of the Chingu Community. We're cons

---

<<<<<<< HEAD

- Suruchi Patki: [GitHub](https://github.com/Supatki) / [LinkedIn](https://www.linkedin.com/in/suruchi-patki-b0710b195/)
- David Eastmond: [GitHub](https://github.com/davideastmond) / [LinkedIn](https://www.linkedin.com/in/david-eastmond-2783ab18a/)
- Mahyar Erfanian: [GitHub](https://github.com/Mahyar-98) / [LinkedIn](https://www.linkedin.com/in/mahyar-erfanian-67968279/)
- Franklin Macedo: [GitHub](https://github.com/frankdias92) / [LinkedIn](https://linkedin.com/in/franklin-md)
- Nandor Nagy: [GitHub](https://github.com/n3ndor) / [LinkedIn](https://www.linkedin.com/in/nandornagylinked/)
- # Eoin McDonnell [GitHub](https://github.com/oldmcdonnell) / [LinkedIn](https://www.linkedin.com/in/mcdonnell-eoin/)...

## Future Contributions

As the project evolves, additional features, components, and updates will be documented here. Stay tuned for more detailed posts as we continue building together!
89 changes: 0 additions & 89 deletions auth.ts

This file was deleted.

6 changes: 0 additions & 6 deletions env.sample
Original file line number Diff line number Diff line change
@@ -1,6 +0,0 @@
DATABASE_URL=
AUTH_GOOGLE_ID=
AUTH_GOOGLE_SECRET=

AUTH_GITHUB_ID=
AUTH_GITHUB_SECRET=
7 changes: 0 additions & 7 deletions nextauth.d.ts

This file was deleted.

Loading