Loading repository data…
crymE-L / repository
nlw-pocket-javascript
This project is a full-stack goals management application developed during RocketSeat's NLW Pocket course.
#biome#docker#drizzle-kit#drizzle-orm#nodejs#postgresql
Live repository statistics
★ 1Stars
⑂ 0Forks
◯ 0Open issues
◉ 1Watchers
41/100
OPENREPOHUB HEALTH SIGNAL
Limited signals
A transparent discovery signal based on current public GitHub metadata.
Recent activity35% weight
10
Community adoption25% weight
0
Maintenance state20% weight
100
License clarity10% weight
100
Project information10% weight
75
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
README preview
🚀 NLW Pocket : JavaScript - Goals Management Application
This is a full-stack goals management application developed during RocketSeat's NLW Pocket course. It helps users add, track, and manage their goals with an intuitive and modern interface.
🖥️ Tech Stack
- Frontend: React, TypeScript, Vite, TanStack Query, Tailwind CSS
- Backend: Node.js, Drizzle ORM, PostgreSQL
- Tools: Docker, Biome, Environment Files (.env), API Calls, Routing
📸 Screenshots
🌟 Features
- Add and manage your goals
- Track completion over time
- Weekly goal summaries
- Clean and responsive UI
📦 Prerequisites
Before you begin, ensure you have the following installed:
🛠️ Setup Guide
Follow these steps to set up the application locally:
1. Clone the Repository
git clone https://github.com/crymE-L/nlw-pocket-javascript.git
cd nlw-pocket-javascript
2. Set Up Environment Variables
Create a .env file in the project root with the following content:
DATABASE_URL=postgresql://user:password@localhost:5432/your-database
REACT_APP_API_URL=http://localhost:3001/api
3. Install Backend Dependencies
cd backend
npm install
4. Install Frontend Dependencies
cd ../frontend
npm install
5. Start Docker Services
Run the following command to spin up a PostgreSQL database according to the configuration in the docker-compose.yml file:
docker-compose up -d
6. Run Migrations
Navigate to the backend folder and run migrations to set up your database:
cd backend
npx drizzle-kit sync:push
7. Start the Backend Server
Inside the backend folder, start the server:
npm run dev
The backend server will start on http://localhost:3001.
8. Start the Frontend Server
Open a new terminal, navigate to the frontend directory, and start the frontend:
cd frontend
npm run dev
The frontend will start on http://localhost:5173.
9. Access the Application
Visit http://localhost:5173 in your browser to start using the app!
🤝 Contributing
Contributions are welcome! Feel free to open issues or submit pull requests.
📝 License
This project is licensed under the MIT License.
📧 Contact
For any inquiries, please contact crymerom@gmail.com.