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

Submission - Regressor #23

Open
wants to merge 1 commit into
base: main
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
35 changes: 29 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,41 @@

## README.md must consist of the following information:

#### Team Name -
#### Team Name - Regressor
#### Problem Statement -
#### Team Leader Email -
#### Team Leader Email - [email protected]

## A Brief of the Prototype:
This section must include UML Diagrams and prototype description
Briefly is a Slack bot that provides concise and actionable digests from selected channels. Its main purpose is to help users stay informed and on top of their game by delivering relevant information without the noise of long messages and threads. It proves to be invaluable for higher officials, product managers, and all employees, as it lists action items and summarizes updates, feature launches, management announcements, and more. By using Briefly, users can prioritize tasks and avoid getting overwhelmed by the flood of messages in Slack. The bot offers the flexibility to customize the updates, allowing users to include only their preferred channels and receive them at their preferred time. Overall, Briefly empowers users to stay efficient and well-informed in their Slack communication.



## Tech Stack:
List Down all technologies used to Build the prototype
1. Python
2. LlamaIndex
3. Slack block kit
4. Next js
5. GCP
6. OpenAI


## Step-by-Step Code Execution Instructions:
This Section must contain a set of instructions required to clone and run the prototype so that it can be tested and deeply analyzed
Our entire project consist of three components
1. Briefly_frontend
Step 1: Install packages
`npm i`
Step 2: Run frontend application
`npm run`

2.slack-app backend
Step:1
`python app.py`

3. Daily_message_sender
This is a cloud function which will be triggered on daily basis to send digest
whenever called it ll send summay



## What I Learned:
Write about the biggest learning you had while developing the prototype
During the hackathon, my most significant learning came from developing the prototype. I discovered the power of integrating advanced analytics tools and the LLM (Large Language Model). The combination allowed us to extract valuable insights from vast amounts of data and generate meaningful summaries and action items. The experience taught me the immense potential of AI-driven solutions in streamlining processes and making informed decisions, which was truly eye-opening and inspiring.Amid the intense 2-day hackathon, managing stress and fostering team building were vital aspects of our success
39 changes: 39 additions & 0 deletions briefly_frontend/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts

# contentlayer
.contentlayer
4 changes: 4 additions & 0 deletions briefly_frontend/.vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"typescript.tsdk": "node_modules/typescript/lib",
"typescript.enablePromptUseWorkspaceTsdk": true
}
33 changes: 33 additions & 0 deletions briefly_frontend/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# CHANGELOG.md

## [3.2.0] - 2023-05-31

Update dependencies and fix some issues

## [3.1.0] - 2023-05-07

Modal video improvements

## [3.0.0] - 2023-04-12

Conversion to Next.js

## [2.0.3] - 2023-03-28

Fix video

## [2.0.2] - 2023-03-28

Add self-hosted video

## [2.0.1] - 2023-02-16

Remove header links

## [2.0.0] - 2023-02-16

Replace Cruip CSS with Tailwind CSS

## [1.0.0] - 2020-04-07

First release
90 changes: 90 additions & 0 deletions briefly_frontend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Free React / Next.js landing page template

![Open React / Next.js template preview](https://user-images.githubusercontent.com/2683512/231426532-c71f4291-4813-401b-a569-ada47fe13efa.png)

**Open** is a **free React / Next.js landing page template built with Tailwind CSS** for developers/makers who want to create a quick and professional landing page for their open source projects, SaaS products, online services, and more.

Use it for whatever you want, and be sure to reach us out on [Twitter](https://twitter.com/Cruip_com) if you build anything cool/useful with it.

Created and maintained with ❤️ by [Cruip.com](https://cruip.com).

*Version 1.0.0 built with the Cruip CSS is available [here](https://github.com/cruip/open-react-template/releases/tag/1.0.0).*
*Version 2.0.3 built with Tailwind CSS and React + Vite is available [here](https://github.com/cruip/open-react-template/releases/tag/2.0.3).*

## Live demo

Check the live demo here 👉️ [https://open.cruip.com/](https://open.cruip.com/)

## Open PRO

[![Open Pro](https://user-images.githubusercontent.com/2683512/151177673-e56ade57-c98d-4c37-b315-d313bd14bb53.png)](https://cruip.com/)

## Design files

If you need the design files, you can download them from Figma's Community 👉 https://bit.ly/401KSUS

## Usage

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).

### Getting Started

First, run the development server:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. 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.ts`.

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.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

### 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!

### 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.


### Support notes
This template has been developed with the App Router (`app`) and React Server Components. If you’re unfamiliar with these beta features, you can find more information about them on the Next.js beta documentation page. So, please note that any request dealing with React (e.g. extra features, customisations, et cetera) is to be considered out of the support scope.

For more information about what support covers, please see our (FAQs)[https://cruip.com/faq/].

## Credits

- [Nucleo](https://nucleoapp.com/)

## Terms and License

- Released under the [GPL](https://www.gnu.org/licenses/gpl-3.0.html).
- Copyright 2023 [Cruip](https://cruip.com/).
- Use it for personal and commercial projects, but please don’t republish, redistribute, or resell the template.
- Attribution is not required, although it is really appreciated.

## About Us

We're an Italian developer/designer duo creating high-quality design/code resources for developers, makers, and startups.

## Stay in the loop

If you would like to know when we release new resources, you can follow us on [Twitter](https://twitter.com/Cruip_com), or you can subscribe to our monthly [newsletter](https://cruip.com/#subscribe).
17 changes: 17 additions & 0 deletions briefly_frontend/app/(auth)/layout.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import PageIllustration from '@/components/page-illustration'

export default function AuthLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<main className="grow">

<PageIllustration />

{children}

</main>
)
}
44 changes: 44 additions & 0 deletions briefly_frontend/app/(auth)/reset-password/page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
export const metadata = {
title: 'Reset Password - Open PRO',
description: 'Page description',
}

import Link from 'next/link'

export default function ResetPassword() {
return (
<section className="relative">
<div className="max-w-6xl mx-auto px-4 sm:px-6">
<div className="pt-32 pb-12 md:pt-40 md:pb-20">

{/* Page header */}
<div className="max-w-3xl mx-auto text-center pb-12 md:pb-20">
<h1 className="h1 mb-4">Forgot your password?</h1>
<p className="text-xl text-gray-400">We'll email you instructions on how to reset it.</p>
</div>

{/* Form */}
<div className="max-w-sm mx-auto">
<form>
<div className="flex flex-wrap -mx-3 mb-4">
<div className="w-full px-3">
<label className="block text-gray-300 text-sm font-medium mb-1" htmlFor="email">Email</label>
<input id="email" type="email" className="form-input w-full text-gray-300" placeholder="[email protected]" required />
</div>
</div>
<div className="flex flex-wrap -mx-3 mt-6">
<div className="w-full px-3">
<button className="btn text-white bg-purple-600 hover:bg-purple-700 w-full">Reset Password</button>
</div>
</div>
</form>
<div className="text-gray-400 text-center mt-6">
<Link href="/signin" className="text-purple-600 hover:text-gray-200 transition duration-150 ease-in-out">Cancel</Link>
</div>
</div>

</div>
</div>
</section>
)
}
78 changes: 78 additions & 0 deletions briefly_frontend/app/(auth)/signin/page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
export const metadata = {
title: 'Sign In - Open PRO',
description: 'Page description',
}

import Link from 'next/link'

export default function SignIn() {
return (
<section className="relative">
<div className="max-w-6xl mx-auto px-4 sm:px-6">
<div className="pt-32 pb-12 md:pt-40 md:pb-20">

{/* Page header */}
<div className="max-w-3xl mx-auto text-center pb-12 md:pb-20">
<h1 className="h1">Welcome back. We exist to make entrepreneurship easier.</h1>
</div>

{/* Form */}
<div className="max-w-sm mx-auto">
<form>
<div className="flex flex-wrap -mx-3">
<div className="w-full px-3">
<button className="btn px-0 text-white bg-red-600 hover:bg-red-700 w-full relative flex items-center">
<svg className="w-4 h-4 fill-current text-white opacity-75 shrink-0 mx-4" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg">
<path d="M7.9 7v2.4H12c-.2 1-1.2 3-4 3-2.4 0-4.3-2-4.3-4.4 0-2.4 2-4.4 4.3-4.4 1.4 0 2.3.6 2.8 1.1l1.9-1.8C11.5 1.7 9.9 1 8 1 4.1 1 1 4.1 1 8s3.1 7 7 7c4 0 6.7-2.8 6.7-6.8 0-.5 0-.8-.1-1.2H7.9z" />
</svg>
<span className="h-6 flex items-center border-r border-white border-opacity-25 mr-4" aria-hidden="true"></span>
<span className="flex-auto pl-16 pr-8 -ml-16">Sign in with Google</span>
</button>
</div>
</div>
</form>
<div className="flex items-center my-6">
<div className="border-t border-gray-700 border-dotted grow mr-3" aria-hidden="true"></div>
<div className="text-gray-400">Or, sign in with your email</div>
<div className="border-t border-gray-700 border-dotted grow ml-3" aria-hidden="true"></div>
</div>
<form>
<div className="flex flex-wrap -mx-3 mb-4">
<div className="w-full px-3">
<label className="block text-gray-300 text-sm font-medium mb-1" htmlFor="email">Email</label>
<input id="email" type="email" className="form-input w-full text-gray-300" placeholder="[email protected]" required />
</div>
</div>
<div className="flex flex-wrap -mx-3 mb-4">
<div className="w-full px-3">
<label className="block text-gray-300 text-sm font-medium mb-1" htmlFor="password">Password</label>
<input id="password" type="password" className="form-input w-full text-gray-300" placeholder="Password (at least 10 characters)" required />
</div>
</div>
<div className="flex flex-wrap -mx-3 mb-4">
<div className="w-full px-3">
<div className="flex justify-between">
<label className="flex items-center">
<input type="checkbox" className="form-checkbox" />
<span className="text-gray-400 ml-2">Keep me signed in</span>
</label>
<Link href="/reset-password" className="text-purple-600 hover:text-gray-200 transition duration-150 ease-in-out">Forgot Password?</Link>
</div>
</div>
</div>
<div className="flex flex-wrap -mx-3 mt-6">
<div className="w-full px-3">
<button className="btn text-white bg-purple-600 hover:bg-purple-700 w-full">Sign in</button>
</div>
</div>
</form>
<div className="text-gray-400 text-center mt-6">
Don’t you have an account? <Link href="/signup" className="text-purple-600 hover:text-gray-200 transition duration-150 ease-in-out">Sign up</Link>
</div>
</div>

</div>
</div>
</section>
)
}
Loading