Skip to content

Commit

Permalink
Create 'MyFunction' function
Browse files Browse the repository at this point in the history
  • Loading branch information
TeamAppwrite committed Nov 18, 2024
1 parent e839ac2 commit 7a122df
Show file tree
Hide file tree
Showing 6 changed files with 254 additions and 1,494 deletions.
133 changes: 133 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# Directory used by Appwrite CLI for local development
.appwrite
6 changes: 6 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"trailingComma": "es5",
"tabWidth": 2,
"semi": true,
"singleQuote": true
}
53 changes: 40 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,48 @@
# Aura Hub
# ⚡ Node.js Starter Function

Aura Hub is a social media platform designed to boost productivity with a suite of features:
A simple starter function. Edit `src/main.js` to get started and create something awesome! 🚀

## Features
## 🧰 Usage

- **Real-time Communication**: Connect and communicate with others instantly.
- **Flashcards**: Create and share flashcards with a scrolling mechanism.
- **Focus Timers**: Boost your productivity with focus timers.
- **Hubs**: Use focus timers together and share educational resources, similar to Discord servers.
### GET /ping

Additionally, Aura Hub includes an innovative feature to manage screen time:
- Returns a "Pong" message.

- **Screen Time Management**: Block certain apps to manage your screen time. Share your screen time usage with friends or followers to encourage mindful device use.
**Response**

## Screenshots
Sample `200` Response:

![Aura Hub Home](/assets/HomePage.png)
![Navigation Route](/assets/NavigationRoute.png)
```text
Pong
```

As a solo developer, I aim to keep the scope manageable but have more features planned for future updates.
### GET, POST, PUT, PATCH, DELETE /

- Returns a "Learn More" JSON response.

**Response**

Sample `200` Response:

```json
{
"motto": "Build like a team of hundreds_",
"learn": "https://appwrite.io/docs",
"connect": "https://appwrite.io/discord",
"getInspired": "https://builtwith.appwrite.io"
}
```

## ⚙️ Configuration

| Setting | Value |
| ----------------- | ------------- |
| Runtime | Node (18.0) |
| Entrypoint | `src/main.js` |
| Build Commands | `npm install` |
| Permissions | `any` |
| Timeout (Seconds) | 15 |

## 🔒 Environment Variables

No environment variables required.
Loading

0 comments on commit 7a122df

Please sign in to comment.